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.
Attribute type
relation
Use it for
Links from one Breakcold record to another, such as person to company or deal to company.
Request value
Send a record ID string. For multi-relation attributes, send an array of record ID strings.
{
"fields": {
"company": "record_company_id"
}
}
Returned shape
Returns a record ID string. Multi-relation attributes return an array of record ID strings.
Example response
{
"fields": {
"company": "record_company_id"
}
}
Multiple values
For a multi-relation attribute, send an array of record ID strings.
{
"fields": {
"companies": [
"record_company_id",
"record_partner_id"
]
}
}
{
"fields": {
"companies": [
"record_company_id",
"record_partner_id"
]
}
}
