API Details

• Carrier Registrations: Specify only the carriers and features (spamRemediation, brandedCallerId) you need (minimum one carrier with at least one feature).
  • No need to specify all three carriers. Omitted features default to false (and will return with a detailedStatus of pending.initialOptOut). Note: this differs from, and is more flexible than, the in-app CSV Upload submission process, which requires all carrier columns in the template (AT&T, T-Mobile, Verizon) even if the value is "No", and takes true/false values rather than "Yes"/"No", but the outcome will be the same.
  • Use a value of true to opt in a phone number to branding or spam remediation for a given carrier feature. Response will return with a detailedStatus of pending.initialOptIn.
  • Use the GET brandedPhoneNumbers endpoint to check on the status of your phone number as it goes through the review process (pending.initialOptIn → submitted.optIn → approved.optIn or rejected.optIn).
• This endpoint is only used to add a phone number for the first time; the PATCH endpoint allows for updating existing registrations including changing carriers or features.

Rate Limit

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.