COcoevera
Email Sequence

EmailSequenceEnrolleds.batch_create_or_update

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

post/entities/EmailSequenceEnrolleds/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 enrolled account.

actor_idstring uuid

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

application_idstring uuid

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

contact_idstring uuid

Id of the enrolled contact.

email_sequence_activity_log_idstring uuid

Id of the activity log run that produced this enrolment.

email_sequence_idstring uuid

Id of the email sequence this enrolment belongs to.

end_reason0 | 1 | 2

Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.

Integer enum value: 0 - NoReason, 1 - Unenrolled, 2 - Finished

end_timestring date-time

Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.

excluded_from_statsboolean

True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).

lead_idstring uuid

Id of the enrolled lead.

oppty_idstring uuid

Id of the enrolled opportunity.

project_idstring uuid

Id of the enrolled project.

start_timestring date-time

Timestamp when the enrolment started.

idstring uuid

ID of object to update.

Example request

[
  {
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "actor_id": "01234567-abcd-dcba-ffff-000000000000",
    "application_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_sequence_activity_log_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "end_time": "2019-01-01T00:00:00",
    "lead_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_time": "2019-01-01T00:00:00"
  }
]

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.