Skip to main content
POST
Create or reactivate suppression.

Body

The suppression entry request payload for the operation.

Request payload for suppression entry.

businessId
string

The business ID associated with this ion entry.

recipientIdentifier
string | null

The recipient identifier value for this ion entry.

phoneNumber
string | null

The phone number associated with this ion entry.

email
string | null

The email address associated with this ion entry.

channel
string

The channel value for this ion entry.

reason
string | null

The human-readable reason explaining this ion entry.

Response

The suppression entry response was created successfully.

API response containing suppression entry data returned to callers.

id
string | null

The unique ID for this ion entry.

businessId
string | null

The business ID associated with this ion entry.

recipientIdentifier
string | null

The recipient identifier value for this ion entry.

normalizedPhoneNumber
string | null

The phone number associated with this ion entry.

normalizedEmail
string | null

The normalized email value for this ion entry.

channel
string | null

The channel value for this ion entry.

source
string | null

The source value for this ion entry.

status
string | null

The current status for this ion entry.

reason
string | null

The human-readable reason explaining this ion entry.

suppressedAt
string<date-time> | null

The date and time for the suppressed at value on this ion entry.

releasedAt
string<date-time> | null

The date and time for the released at value on this ion entry.

audit
object[]

The audit included with this ion entry.