v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Email Sequence

EmailSequenceEnrolleds.update

Modifies EmailSequenceEnrolled or EmailSequenceEnrolleds with given id(s)

patch/entities/EmailSequenceEnrolleds/{id}

Path parameters

idstring uuid required

ID of EmailSequenceEnrolled to update

Query parameters

validation-levelinteger

Specify validation level of EmailSequenceEnrolled on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

account_idstring uuid

Id of the enrolled account.

actor_idstring uuid

Id of the actor.

application_idstring uuid

Id of the application.

contact_idstring uuid

Id of the enrolled contact.

email_sequence_activity_log_idstring uuid

Id of the activity log.

email_sequence_idstring uuid

Id of the email sequence.

end_reason0 | 1 | 2

Why the enrolment ended (e.g. Reply, Unsubscribe, Bounce, Manual, Completed).

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.

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

Modification confirmation. Returns resulting EmailSequenceEnrolled

successboolean

True when response 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"
  }
}