COcoevera
Email Sequence

EmailSequences.update

Changes fields of the EmailSequence record with the given id; fields left out keep their values.

patch/entities/EmailSequences/{id}

Request

Path parameters

idstring uuid required

Id of the EmailSequence record to update.

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

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). This payload conforms to the EmailSequenceSchema JSON Schema (see the linked schema).

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

The changed EmailSequence 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",
    "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
  }
}

Changes

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