EmailSequenceEnrolleds.update

Modifies EmailSequenceEnrolled or EmailSequenceEnrolleds with given id(s)

Request

Path Params

string <uuid>

required

ID of EmailSequenceEnrolled to update

Query Params

validation-level

integer <int32>

optional

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.

Body Params application/json

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

actor_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

application_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_activity_log_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

end_reason

enum<integer>

optional

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

Allowed values:

012

Example:

end_time

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

excluded_from_stats

boolean

optional

Boolean value.

Example:

false

lead_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

start_time

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

Example

{
    "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_reason": 0,
    "end_time": "2019-01-01T00:00:00",
    "excluded_from_stats": false,
    "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"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting EmailSequenceEnrolled

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (EmailSequenceEnrolled)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

actor

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

application

string <uri>

required

Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.

contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

email_sequence_activity_log

string <uri>

required

Relation to EmailSequenceActivityLog. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequenceActivityLog' object for properties.

email_sequence

string <uri>

required

Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

project

string <uri>

optional

Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

actor_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

application_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_activity_log_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

end_reason

enum<integer>

optional

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

Allowed values:

012

Example:

end_time

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

entity_id

string <uuid>

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

entity_type

enum<integer>

read-onlyrequired

Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product

Allowed values:

123456789101112

Example:

excluded_from_stats

boolean

optional

Boolean value.

Example:

false

lead_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

start_time

string <date-time>

required

Datetime information.

Example:

2019-01-01T00:00:00

step_count

integer <int32>

required

Whole natural number.

Example:

step_index

integer <int32>

optional

Example:

entity_name

string

required

Example:

string

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "account": "http://example.com",
        "actor": "http://example.com",
        "application": "http://example.com",
        "contact": "http://example.com",
        "email_sequence_activity_log": "http://example.com",
        "email_sequence": "http://example.com",
        "lead": "http://example.com",
        "oppty": "http://example.com",
        "project": "http://example.com",
        "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_reason": 0,
        "end_time": "2019-01-01T00:00:00",
        "entity_id": "01234567-abcd-dcba-ffff-000000000000",
        "entity_type": 1,
        "excluded_from_stats": false,
        "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"
    }
}

🟠404Record Not Found

🔴500Server Error