Skip to main content
POST
Import call opt outs

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json
entries
object[]
required

1 to 5,000 entries, each with exactly one of phoneNumber (E.164) or bsuid, and an optional note. Invalid entries are reported in rejected and the others are added.

Value constraints

Required array length: 1 - 5000 elements

Response

Import result.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.