v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Lead & Opportunity

LeadOpptyContactGroupRelations.update

Modifies LeadOpptyContactGroupRelation or LeadOpptyContactGroupRelations with given id(s)

patch/entities/LeadOpptyContactGroupRelations/{id}

Path parameters

idstring uuid required

ID of LeadOpptyContactGroupRelation to update

Query parameters

validation-levelinteger

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

colorinteger

Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.

group_positionobject

Org-chart layout of the contact group, as a JSON object {"x": <int>, "y": <int>, "width": <int>, "height": <int>}.

lead_oppty_idstring uuid

Id of the lead or opportunity the contact group belongs to.

namestring

Name of the entity and its default text representation.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "color": 1,
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "name": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting LeadOpptyContactGroupRelation

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