v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Lead & Opportunity

LeadOpptySharingSalesUnitRelations.update

Modifies LeadOpptySharingSalesUnitRelation or LeadOpptySharingSalesUnitRelations with given id(s)

patch/entities/LeadOpptySharingSalesUnitRelations/{id}

Path parameters

idstring uuid required

ID of LeadOpptySharingSalesUnitRelation to update

Query parameters

validation-levelinteger

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

lead_oppty_idstring uuid

Id of the lead or opportunity being shared.

role1 | 2

Sharing role granting the unit a specific access level (e.g. Read, Edit) on the lead or opportunity.

Integer enum value: 1 - Watcher, 2 - Editor

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "role": 1,
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting LeadOpptySharingSalesUnitRelation

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