COcoevera
Email Sequence

EmailSequenceEnrolleds.create

Creates a EmailSequenceEnrolled record.

post/entities/EmailSequenceEnrolleds

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.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

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 required

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 required

Id of the activity log run that produced this enrolment.

email_sequence_idstring uuid required

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 required

Timestamp when the enrolment started.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "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

The created EmailSequenceEnrolled record.

successboolean

True when the request 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",
    "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",
    "entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "entity_type": 1,
    "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",
    "step_count": 1,
    "step_index": 1,
    "entity_name": "string"
  }
}

Changes

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