Bulk-import a suppression list (up to 500 numbers)

POST/v1/consent/import

Body Parameters

  • phone_numbersarray of stringrequired

    At most 500 items.

Responses

  • 200JSON object

    Import counts

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectstring

    Example: consent_import.

  • importedinteger
  • skippedarray of object
  • skipped[].valuestring
  • skipped[].reasonstring

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded