COcoevera
Activity

ActivityRelations.batch_create_or_update

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

post/entities/ActivityRelations/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

account_idstring uuid

Id of the linked account.

activity_idstring uuid

Id of the appointment or task on this link.

contact_idstring uuid

Id of the linked contact.

custom_entity_idstring uuid

Id of the linked custom entity record.

lead_oppty_idstring uuid

Id of the lead or opportunity the activity is linked to, or empty when not linked.

project_idstring uuid

Id of the linked project.

project_objective_idstring uuid

Id of the project objective the activity advances, or empty when it is not linked to one.

quote_idstring uuid

Id of the linked quote.

sort_orderinteger

Display order of the activity within its project objective. Required only when project_id is set.

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

[
  {
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "activity_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_objective_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "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.