v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Contacts

Mark or unmark contacts as bounced

<small>Requires the contacts:operate scope (or a broader one that includes it).</small>

Marks the given contacts as bounced (isBounced: true) or clears the bounced flag (isBounced: false) across every sequence they are currently enrolled in.

When clearing the flag (isBounced: false), resendEmails is required: pass true to retry the previously bounced step or false to leave the schedule untouched. When marking as bounced (isBounced: true), resendEmails must be omitted.

To restrict the change to a single sequence, use POST /v3/sequences/{id}/contacts/set-bounced instead.

post/v3/contacts/set-bounced

Request body

contactIdsinteger[] required

Contact IDs to update. At least one, at most 100. Each ID must be positive.

isBouncedboolean required

true marks the contacts as bounced; false clears the bounced flag.

resendEmailsboolean nullable

Required (non-null) when isBounced=false; must be omitted when isBounced=true. When true, the previously bounced step is rescheduled for retry.

Response

Non-atomic result. The response body is a dictionary keyed by contact id listing per-item failures. Empty object {} means all contacts were updated successfully.

Per-item failures use the ContactError enum. Common per-item slugs:

Slug	Meaning
notFound	Contact does not exist
forbidden	Caller lacks permission for this contact
sequenceNotFound	Derived sequence not accessible
invalidInput	Value rejected for this contact

object required

Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.