---
title: "EmailSequences.update"
method: PATCH
path: "/entities/EmailSequences/{id}"
tags: ["Email Sequence"]
---

# EmailSequences.update

`PATCH /entities/EmailSequences/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/EmailSequences/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/EmailSequences/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateEmailSequenceInput: Field values to change on an EmailSequence record; fields left out keep their values.
  - `description` string: Free-form description of the sequence.
  - `name` string: Display name of the email sequence.
  - `owner_id` string, uuid: Id of the email sequence owner.
  - `settings` object: 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).
  - `type` 1 | 2: Process category of the sequence (e.g. EmailSequence vs other process types). Integer enum value: 1 - Personal, 2 - Space
  - `documents` object[]: Attachments and other documents linked to this sequence.
    - `id` string, uuid: Id of the related CloudObjectRelation record.

## Response `200`

The changed EmailSequence record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` EmailSequence: Automated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `owner` string, uri, required: User who owns this email sequence. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `deactivation_reason` 0 | 1 | 2 | 3: Reason the sequence is currently disabled (e.g. Manual stop, system suspension). Read-only. Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature
    - `description` string: Free-form description of the sequence.
    - `is_enabled` boolean: Master switch for the sequence. Read-only on this surface — change it via the enable / disable mutations.
    - `last_schema_change` string, date-time: Timestamp of the most recent change to settings. Read-only.
    - `last_status_change` string, date-time: Timestamp of the most recent change to is_enabled. Read-only.
    - `name` string, required: Display name of the email sequence.
    - `owner_id` string, uuid, required: Id of the email sequence owner.
    - `settings` object: 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).
    - `type` 1 | 2, required: Process category of the sequence (e.g. EmailSequence vs other process types). Integer enum value: 1 - Personal, 2 - Space
    - `activity_logs` string[]: Run history of the sequence — one log per scheduled execution.
    - `documents` string[]: Attachments and other documents linked to this sequence.
    - `enrolled` string[]: Enrolment records (recipients currently or previously running through the sequence).

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)