Phone Suppression
Get suppression request status
Check whether a request to block phone numbers has finished. Use the jobId you got back from Suppress phone numbers. Returns queued, active, completed, or failed, with counts and row errors when available. Requires phone_suppression.manage and the same organization and user that submitted the request. This is an operation status, not a lookup of a number's current suppression state.
Authorization
x-api-key x-api-key<token>
API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Path Parameters
string
GET /v2/phone-suppressions/suppress/:id Parameter
Match^[a-zA-Z0-9-]+$Length1 <= length <= 128
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.carecycle.ai/v2/phone-suppressions/suppress/string"{
"jobId": "string",
"state": "queued",
"createdAt": "string",
"finishedAt": null,
"progress": {
"processed": 0,
"total": 0,
"phase": "queued"
},
"result": {
"kind": "api",
"summary": {
"total": 0,
"valid": 0,
"duplicates": 0,
"invalid": 0,
"defaultedReasons": 0,
"created": 0,
"existing": 0,
"replayed": 0,
"failed": 0,
"errors": [
{
"row": 0,
"message": "string"
}
]
}
},
"error": "string"
}{
"message": "string",
"code": "string",
"details": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string",
"details": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
],
"failedRecords": [
{
"index": 0,
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"externalId": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}