COcoevera
Lead & Opportunity

LeadOpptyContactRelations.batch_create_or_update

Creates or updates LeadOpptyContactRelation records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/LeadOpptyContactRelations/batch-modify

Request

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

commentstring

Free-form note describing this contact link.

contact_idstring uuid

Id of the contact linked to the lead or opportunity.

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.

lead_oppty_contact_group_relation_idstring uuid

Id of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity.

lead_oppty_idstring uuid

Id of the lead or opportunity this link belongs to.

position_in_groupobject

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

relationship0 | 1 | 2 | 3

Org-chart relationship of the contact within the lead/opportunity hierarchy.

Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

[
  {
    "comment": "string",
    "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

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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