Stop writing to an address or number

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:write

Graphql

Mutation.contactsSuppressionAdd

Sdk

contacts.suppression.add

Cli

contacts suppression add

Request bodyapplication/json, required

• channelstringrequired
  One of: email, sms, whatsapp, phone.
• valuestringrequired
  At most 320 characters.
• reasonstring
  One of: unsubscribed, manual, stop, invalid. Default: manual.

Responses

• 201application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring