Skip to main content

​
1. Get the Field ID You Want to Update

To update a custom attribute, you first need its Field ID. Here’s how to find it:
  1. Navigate to Person or Company Settings in your Breakcold workspace settings
  2. Locate the field you want to update.
  3. Click on the three dots next to the field and select Copy attribute ID.

​
Special Note for Select, MultiSelect, Location,Date, or Relation Attribute Types

Custom attributes can have special behaviors depending on their types. Here are some key points to remember:
  • Select, MultiSelect Attributes: The value can be a single option ID or an array of option IDs. The backend will handle the conversion automatically.
  • Location Attributes: The value should be an object with the following properties: 
    {
  "latitude": 48.8566,
  "longitude": 2.3522,
  "address": "Paris, France"
}
  • Date Attributes: The value must be in ISO 8601 format.
  • Relation Attributes: The value must be the ID of the related lead.

​
2. Create or Update a Lead with Custom Attributes

When creating or updating a lead, include the attributes you want to modify in the body of the API request. Here’s an example: 
{
  "attributes": {
    "company-size": 500,
    "last-contact-date": "2023-05-10T14:30:00Z",
    "is-qualified": true,
    "industry": "option-id-tech",
    "date": "2023-05-10T14:30:00Z",
    "interests": ["option-id-ai", "option-id-cloud"],
    "location": {
      "latitude": 48.8566,
      "longitude": 2.3522,
      "address": "Paris, France"
    },
    "related-lead": "lead-id-12345",
    "notes": "Interested in our enterprise solution"
  }
}

​
Important Notes:

  • Ensure that all Select or MultiSelect attribute values are valid IDs. Incorrect or unrecognized IDs will result in an error.
  • Location Attributes: The backend expects latitude, longitude, and address values to be present in the object.
  • Relation Attributes: The value must be the ID of the related lead.
  • Date Attributes: The value must be in ISO 8601 format.
For more details on request structure and available endpoints, refer to the API Reference.

​
Error Handling

  • Unrecognized IDs or invalid values for Select, Relation or MultiSelect attributes will return an error.
  • Ensure proper data structure for Location attributes.
For more details on request structure and available endpoints, refer to the API Reference.

​
3. You’re Done! 🎉

Congratulations! You’ve successfully used custom attributes in Breakcold. If you encounter any errors, double-check your Field IDs and values, especially for Select, Location, and Relation attributes.