COcoevera
Email Sequence

EmailSequenceActivityLogs.batch_create_or_update

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

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

actor_idstring uuid

Id of the user who initiated the run, or empty for runs triggered by automation.

application_idstring uuid

Id of the application (e.g. browser, automation, third-party integration) the run was triggered in.

email_sequence_idstring uuid

Id of the email sequence this activity log belongs to.

end_timestring date-time

Timestamp when the run finished. Empty for runs still in progress.

is_test_runboolean

True when the run was a dry-run / test execution and did not produce real-side effects.

start_timestring date-time

Timestamp when the run started.

status1 | 2 | 3 | 4 | 5

Outcome of the run (e.g. Ok, Error, Cancelled).

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

idstring uuid

ID of object to update.

Example request

[
  {
    "actor_id": "01234567-abcd-dcba-ffff-000000000000",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "end_time": "2019-01-01T00:00:00",
    "start_time": "2019-01-01T00:00:00",
    "status": 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.