Mark or unmark contacts as bounced in this sequence
<small>Requires the sequences: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), scoped to this sequence only.
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 apply across every sequence a contact is in, use POST /v3/contacts/set-bounced instead.
Request
- Base URLhttps://api.reply.io
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Sequence ID
Request body
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 SequenceContactError enum. Common per-item slugs:
| Slug | Meaning |
|---|---|
| invalidInput | Generic validation failure for this contact |
| contactNotFound | Contact does not exist |
| notInSequence | Contact is not in this sequence |
| forbidden | Caller lacks permission for this contact |
Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.
Changes
No recorded changes to this operation across all 1 revision of this API.