Skip to main content
DELETE
Remove a recipient from 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
contactId
string
required

The ID of the person (per_…) or company (com_…) to remove. A contact merged into another resolves to it.

Maximum string length: 64

Response

The campaign, without the recipient.

data
object
required

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

Example:
deprecations
string[]
Example: