Skip to main content
POST
Stop a campaign

Authorizations

Authorization
string
header
required

API key for authentication

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

campaignId
string
required

The ID of the campaign.

Required string length: 40

Body

application/json
recipientIds
string[]

Stop only these people or companies, at most 100: every message of theirs not sent yet, in every step, is not sent. The campaign keeps its status and its other recipients still receive their messages. Omit to stop the whole campaign.

Required array length: 1 - 100 elements
Required string length: 40
Example:

Response

The campaign, once stopped.

data
object
required

A campaign: one or more emails, each a step, sent to a list of people or companies.

Example:
deprecations
string[]
Example: