post
https://api.regal.ai/v1/brandedPhoneNumbers
Post a phone number for spam remediation and/or branding.
Rate Limit
| Limit Type | Value |
|---|---|
| Requests per second | 10 |
If you exceed these limits, you will receive a 429 Rate Limit Exceeded response.
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
detailedStatusofpending.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 intrue/falsevalues rather than "Yes"/"No", but the outcome will be the same. - Use a value of
trueto opt in a phone number to branding or spam remediation for a given carrier feature. Response will return with adetailedStatusofpending.initialOptIn - Use the GET brandedPhoneNumbers to check on the status of your phone number as it goes through the review process (
pending.initialOptIn-->submitted.OptIn-->approved.OptInorrejected.OptIn)
- No need to specify all three carriers. Omitted features default to false (and will return with a
- POST endpoint is only used to add a phone number for the first time; PATCH endpoint allows for updating existing registrations including changing carriers or features.