Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Contact

GhostContactAccountRelations.update

Modifies GhostContactAccountRelation or GhostContactAccountRelations with given id(s)

patch/entities/GhostContactAccountRelations/{id}

Path parameters

idstring uuid required

ID of GhostContactAccountRelation to update

Query parameters

validation-levelinteger

Specify validation level of GhostContactAccountRelation 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-text comment shown on the org-chart node.

ghost_contact_idstring uuid

Id of the ghost contact.

is_assistantboolean

True when the ghost contact is rendered as an assistant of its parent in the org chart.

is_siblingboolean

True when the ghost contact is rendered as a sibling rather than a child in the org chart.

positionstring

Position label shown on the org chart for the ghost contact.

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

Modification confirmation. Returns resulting GhostContactAccountRelation

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",
    "ghost_contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "revision": 1
  }
}