Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

Attributes are the fields configured on an object. In the API, record attributes are sent and returned in the fields object. Each attribute has a field definition in Breakcold: a slug, a display name, a field type, and settings such as whether it accepts one value or multiple values. The slug is the JSON key you use inside fields. 
{
  "workspaceId": "workspace_id",
  "objectTypeSlug": "person",
  "fields": {
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "linkedin": "https://www.linkedin.com/in/ada-lovelace",
    "company": "company_record_id"
  }
}
  • Attributes are returned inside record.fields.
  • Field slugs are the JSON keys inside fields.
  • Empty or unset values are omitted from fields.
  • Attributes configured to accept multiple values return arrays. Type pages include multiple-value examples when the API accepts array input for that attribute type.
Unknown field slugs are rejected. Use the exact slug configured for the object type you are creating or updating.