Suppress an email channel

Suppress an existing email channel, disallowing any future delivery from being fulfilled for the channel.

post/api/channels/email/suppress

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopeschn
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/channels/email/suppress/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

addressstring required

The email address for the channel to be suppressed.

reason'spam_complaint' | 'commercial_spam_complaint' | 'bounce' | 'imported' required

The reason for suppressing the channel. If there is no specific reason, use imported.

Example request

{
  "address": "user@example.com",
  "reason": "spam_complaint"
}

Response

Returns OK for success.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes

No recorded changes to this operation across all 9 revisions of this API.