Do Not Call

List the Do Not Call list, newest first

GET /v1/dnc dnc:read

Query

• e164 string

  Look up one number

• limit integer
• cursor string

Responses

• 200

  A page of numbers

  Fields

  • data DncNumber[] required
    Fields

    • e164 string required
    • reason string | null required
    • source "api" | "dashboard" | "disposition" | "import" | "crm" required

      api, dashboard, disposition (a rep recorded a DNC disposition), import (a CSV) or crm (a revocation in your CRM)

    • createdBy string | null required

      The API key, dashboard user or rep that added it

    • createdAt string required
  • nextCursor string | null required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code

Add a number to the Do Not Call list

POST /v1/dnc dnc:write

Idempotent: a number already on the list is returned as it is (200).

Headers

• Idempotency-Key string

  Makes the request safe to retry. For 24h, a request with the same key and body replays the stored response (with Idempotent-Replayed: true); the same key with a different request is a 422 idempotency_key_reused, and while the first request is still running a 409 idempotency_key_in_use. Server errors, 409s and 429s are not stored.

Body

• e164 string required
• reason string | null

Responses

• 200

  Already on the list

  Fields

  • data DncNumber required

    A number on the workspace's internal Do Not Call list: reps' outbound calls to it are refused with 422 do_not_call. Scoped to the API key environment.

    Fields

    • e164 string required
    • reason string | null required
    • source "api" | "dashboard" | "disposition" | "import" | "crm" required

      api, dashboard, disposition (a rep recorded a DNC disposition), import (a CSV) or crm (a revocation in your CRM)

    • createdBy string | null required

      The API key, dashboard user or rep that added it

    • createdAt string required
• 201

  Added

  Fields

  • data DncNumber required

    A number on the workspace's internal Do Not Call list: reps' outbound calls to it are refused with 422 do_not_call. Scoped to the API key environment.

    Fields

    • e164 string required
    • reason string | null required
    • source "api" | "dashboard" | "disposition" | "import" | "crm" required

      api, dashboard, disposition (a rep recorded a DNC disposition), import (a CSV) or crm (a revocation in your CRM)

    • createdBy string | null required

      The API key, dashboard user or rep that added it

    • createdAt string required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 409

  idempotency_key_in_use: a request with this key is still running

• 422

  idempotency_key_reused: this key was used with a different request

• 429

  rate_limited, or another limit named by error.code

Remove a number from the Do Not Call list

DELETE /v1/dnc/{e164} dnc:write

Idempotent: removing a number that is not on the list also answers 204.

Path

• e164 string required

Responses

• 204

  Removed

• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code