Suppress phone numbers

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"
    }
  ]
}

curl -X POST "https://api.carecycle.ai/v2/phone-suppressions/suppress" \  -H "Content-Type: application/json" \  -d '{    "records": [      {        "phoneNumber": "strings"      }    ]  }'

{
  "jobId": "string",
  "status": "accepted",
  "acceptedCount": -9007199254740991
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "string",
  "code": "string"
}

{
  "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"
}