Records
Update a CRM Record Relation
Add or remove individual record and team-member links on a relation or user attribute of a Zeeg CRM record without overwriting existing linked IDs
PATCH
Update a CRM record relation
Adds or removes individual IDs from a
relation or user attribute on a CRM record. Unlike Patch, which replaces the entire array, this endpoint performs surgical add/remove operations — existing linked IDs not mentioned in the request are untouched.
Path parameters
Request body
Rules:
- At least one of
addorremovemust be present and non-empty. - The same ID cannot appear in both
addandremovein the same request. - Passing an ID in
addthat is already linked is a no-op (not an error). - Passing an ID in
removethat is not linked is a no-op (not an error).
Attribute types that support this endpoint
Passing this endpoint for a
text, number, select, or any non-relation attribute returns an error. Use Patch for those.
Example: link products to an order
Yourorders object has a relation attribute called products that links to the products object. To add two products to an order:
Example: swap a linked record
Remove one product and add a replacement in a single request:Example: unlink all products one at a time
To remove products, pass their IDs inremove:
Example: assign a team member to a deal
Yourdeals object has a user attribute called owners. To assign a team member:
Finding the attribute slug
Relation attribute slugs are defined when the attribute is created. You can look them up viaGET /v2/crm/objects/{slug} — look for attributes with type: relation or type: user and use their key field as attributeSlug.
Update Relation vs. PATCH
Use
PATCH /relation when you need additive or subtractive changes. Use PATCH /{recordId} when you want to set the exact final state of a relation (replacing whatever was there before).
When to use this endpoint
- Add a linked record — a user picks a related product, company, or person to attach.
- Remove a linked record — a user detaches a relation without affecting others.
- Assign / unassign owners — add or remove team members from a user-type attribute.
- Incremental sync — when your source system sends delta events (“product X was added to order Y”) rather than full state.
Authorizations
Path Parameters
Slug of the custom CRM object.
UUID of the record to update.
Body
application/json
Last modified on June 11, 2026