Skip to main content
POST
Change workflow mailing list

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowId
string
required

The ID of the workflow.

Body

application/json
expectedRevisionId
string | null
required

The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass null back as expectedRevisionId in that case. If the token is stale, the API returns a 409 Conflict error.

mailingListId
string | null
required

The mailing list to use for the workflow. When assigning a mailing list, queued contacts excluded by the new list can return queuedContactsFound; retry with queuedContactPolicy: "discard" to apply the change and discard those contacts. Use null to clear the workflow mailing list; clearing does not discard queued contacts.

dryRun
boolean

If true, the request will be validated but the workflow will not be modified.

queuedContactPolicy
enum<string>
default:fail

fail returns queued-contact impact instead of mutating. discard confirms that matching queued contacts should be discarded. Defaults to fail when omitted.

Available options:
fail,
discard

Response

Mailing-list dry run, queued-contact warning, or update result. Confirmed update responses include the simplified workflow after the mailing list changes.

status
enum<string>
required
Available options:
dryRun,
queuedContactsFound
mailingListId
string | null
required
queuedContactCount
number
required

The number of queued contacts that would be removed from the workflow due to the mailing list changing.

Last modified on August 14, 2026