CAcarecycle
Phone Suppressions

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.

get/v2/phone-suppressions/suppress/{id}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/phone-suppressions/suppress/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

GET /v2/phone-suppressions/suppress/:id Parameter

Response

GET /v2/phone-suppressions/suppress/:id Positive response

jobIdstring required
state'queued' | 'active' | 'completed' | 'failed' required
createdAtstring required
finishedAtnumber nullable required
errorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.