v4

OpenAPI 3.1.02026-07-3163216290.7 KB

Workflows

Change workflow mailing list

Dry run or apply a workflow mailing list change. If queued contacts would be removed from the workflow due to the change of mailing list, Loops returns with "status": "queuedContactsFound" instead of applying the change. Retry with queuedContactPolicy: "discard" to apply the change and discard those contacts.

post/v1/workflows/{workflowId}/mailing-list

Request body

expectedRevisionIdstring nullable 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.

mailingListIdstring nullable 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.

dryRunboolean

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

queuedContactPolicy'fail' | 'discard'

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

Response

Mailing-list dry run, queued-contact warning, or update result.