Suppress phone numbers
Block phone numbers so careCycle never contacts them and they can't call in. The block applies to your whole organization.
Send a body containing only records. The server generates the operation identity and returns a jobId. No client-generated key is required. An optional Idempotency-Key header (1 to 200 characters) lets you reuse the same operation when retrying with the same records, including after a lost response. Reusing a supplied key with different records returns 409. Without the header, each submission creates a new operation. Poll GET /v2/phone-suppressions/suppress/{jobId} with the same caller credentials to obtain progress and the final outcome; it requires phone_suppression.manage with the standard View prerequisite.
Submit one or more phone numbers in the records array, up to 1,000 per request. Each record contains phoneNumber and an optional reason. Formatting is normalized automatically; blank or unrecognized reasons become other. Duplicate numbers use the first record. Requires phone_suppression.manage. The response acknowledges records accepted for processing.
Single record:
{
"records": [
{
"phoneNumber": "2125550123",
"reason": "customer_request"
}
]
}
Multiple records:
{
"records": [
{
"phoneNumber": "2125550123",
"reason": "customer_request"
},
{
"phoneNumber": "+1 (212) 555-0124",
"reason": "other"
}
]
}
Request
- Base URLhttps://api.carecycle.ai
- URLhttps://api.carecycle.ai/v2/phone-suppressions/suppress
- AuthAPI key in header x-api-key
Headers
Optional retry key. Omit it to let the server create a new operation. When supplied, reuse it with the same records for retries; use a new key for a new operation.
Request body
Response
POST /v2/phone-suppressions/suppress Positive response
Changes
No recorded changes to this operation across all 2 revisions of this API.