Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Contact

ContactAccountRelations.update

Modifies ContactAccountRelation or ContactAccountRelations with given id(s)

patch/entities/ContactAccountRelations/{id}

Path parameters

idstring uuid required

ID of ContactAccountRelation to update

Query parameters

validation-levelinteger

Specify validation level of ContactAccountRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the account.

commentstring

Free-form note describing this contact-account link.

contact_idstring uuid

Id of the contact.

is_assistantboolean

True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.

is_primaryboolean

True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row.

is_siblingboolean

True when the contact is a sibling node on the account org chart (no parent/child reporting line).

positionstring

Job title or position the contact holds at the account.

relationship0 | 1 | 2 | 3

Org-chart relationship of the contact within the account hierarchy.

Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "comment": "string",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "position": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ContactAccountRelation

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "comment": "string",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "revision": 1
  }
}