Skip to main content
POST
sms.registration-toll-free.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by sms.registration-toll-free.submit or a row of sms.registration-toll-free.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
businessName
string
required

Name of the sending business.

Required string length: 1 - 255
businessWebsite
string
required

Public HTTPS business website.

businessStreetAddress
string
required

Business street address.

Required string length: 1 - 255
businessCity
string
required

Business city.

Required string length: 1 - 100
businessRegion
string
required

Business state or region.

Required string length: 1 - 100
businessPostalCode
string
required

Business postal code.

Required string length: 1 - 20
businessCountry
string
required

Two-letter business country.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
contactFirstName
string
required

Business contact's first name.

Required string length: 1 - 100
contactLastName
string
required

Business contact's last name.

Required string length: 1 - 100
contactEmail
string<email>
required

Business contact's email.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
contactPhone
string
required

Business contact's phone in international format.

Pattern: ^\+[1-9]\d{6,14}$
businessType
enum<string>
required

Legal business type.

Available options:
private_profit,
public_profit,
sole_proprietor,
non_profit,
government
useCaseCategories
enum<string>[]
required

Purposes of these messages.

Required array length: 1 - 14 elements
Available options:
two_factor_authentication,
account_notifications,
customer_care,
charity_nonprofit,
delivery_notifications,
fraud_alert_messaging,
events,
higher_education,
k12,
marketing,
polling_and_voting_non_political,
political_election_campaigns,
public_service_announcement,
security_alert
useCaseSummary
string
required

How the business uses messaging.

Required string length: 1 - 2048
messageSample
string
required

An example message, including opt-out wording.

Required string length: 1 - 1024
optInType
enum<string>
required

How recipients agree to messages.

Available options:
verbal,
web_form,
paper_form,
via_text,
mobile_qr_code,
import,
import_please_replace
optInEvidenceUrls
string[]
required

Public HTTPS images showing how recipients agree to messages.

Required array length: 1 - 10 elements
monthlyMessageVolume
enum<string>
required

Estimated monthly message volume.

Available options:
1,000,
10,000,
100,000,
250,000,
500,000,
750,000,
1,000,000,
5,000,000,
10,000,000+
privacyPolicyUrl
string
required

Public HTTPS privacy policy.

termsUrl
string
required

Public HTTPS messaging terms.

editReason
string
required

Why this filing is being corrected.

Required string length: 1 - 1024
businessRegistrationNumber
string

Official business registration number; required except for sole proprietors.

Required string length: 1 - 100
businessRegistrationAuthority
enum<string>

Authority that issued the registration; required except for sole proprietors.

Available options:
EIN,
CBN,
CRN,
PROVINCIAL_NUMBER,
VAT,
ACN,
ABN,
BRN,
SIREN,
SIRET,
NZBN,
USt-IdNr,
CIF,
NIF,
CNPJ,
UID,
NEQ,
OTHER
businessRegistrationCountry
string

Two-letter registration country; required except for sole proprietors.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
politicalVettingToken
string

Political campaign verification token, forwarded once and never returned.

Required string length: 1 - 500

Response

The result

phoneNumber
string
required

Your toll-free sending number.

Pattern: ^\+[1-9]\d{6,14}$
state
enum<string>
required

Current filing review state.

Available options:
pending,
in_review,
approved,
rejected
canSend
boolean
required

Whether this number has approved verification; delivery is not guaranteed.

editable
boolean
required

Whether the filing can still be edited.

editExpiresAt
string

Editing deadline, in UTC.