DestinationSuppressionStateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The suppression state of a single destination, as shown on the destinations grid and add/edit page.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
suppressionId
required |
string (uuid) | The suppression record's id, for correlating this state with the row on the suppressions
management grid or in the suppressions API.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isActivelySuppressed
required |
boolean | Whether deliveries are being skipped right now.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
reason
required |
DestinationSuppressionReason DestinationSuppressionReason | Why the endpoint was suppressed. Null when the row is only tracking failures.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
suppressedAtUtc
required |
string (date-time) | UTC timestamp at which the endpoint became suppressed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
expiresAtUtc
required |
string (date-time) | UTC timestamp at which the suppression auto-expires and the endpoint is re-probed. Null means
it never auto-expires and only a manual clear will resume delivery.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
consecutiveFailures
required |
integer (int32) | Consecutive hard failures recorded against the endpoint.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.