COcoevera
Contact

ContactAccountRelations.update

Changes fields of the ContactAccountRelation record with the given id; fields left out keep their values.

patch/entities/ContactAccountRelations/{id}

Request

Path parameters

idstring uuid required

Id of the ContactAccountRelation record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

account_idstring uuid

Id of the account the contact is linked to.

commentstring

Free-form note describing this contact-account link.

contact_idstring uuid

Id of the contact linked to the account.

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

The changed ContactAccountRelation record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.