v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Email Sequence

EmailSequences.update

Modifies EmailSequence or EmailSequences with given id(s)

patch/entities/EmailSequences/{id}

Path parameters

idstring uuid required

ID of EmailSequence to update

Query parameters

validation-levelinteger

Specify validation level of EmailSequence 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

descriptionstring

Free-form description of the sequence.

namestring

Display name of the email sequence.

owner_idstring uuid

Id of the email sequence owner.

settingsobject

JSON schema describing the sequence trigger, nodes (steps) and global actions (e.g. on-reply, on-bounce, on-unsubscribe).

type1 | 2

Process category of the sequence (e.g. EmailSequence vs other process types).

Integer enum value: 1 - Personal, 2 - Space

Example request

{
  "description": "string",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "type": 1
}

Response

Modification confirmation. Returns resulting EmailSequence

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",
    "description": "string",
    "last_schema_change": "2019-01-01T00:00:00",
    "last_status_change": "2019-01-01T00:00:00",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 1
  }
}