v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Contact

GhostLeadOpptyContactRelations.update

Modifies GhostLeadOpptyContactRelation or GhostLeadOpptyContactRelations with given id(s)

patch/entities/GhostLeadOpptyContactRelations/{id}

Path parameters

idstring uuid required

ID of GhostLeadOpptyContactRelation to update

Query parameters

validation-levelinteger

Specify validation level of GhostLeadOpptyContactRelation 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

commentstring

Free-text comment shown on the org-chart node.

ghost_contact_idstring uuid

Id of the ghost contact.

lead_oppty_contact_group_relation_idstring uuid

Id of the parent org-chart group.

lead_oppty_idstring uuid

Id of the linked lead or opportunity.

position_in_groupobject

Org-chart layout position of the ghost contact within its group, as a JSON object {"x": <int>, "y": <int>}.

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

Modification confirmation. Returns resulting GhostLeadOpptyContactRelation

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