Sign in

v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
SMS

Enable SMS on a number

Turns on SMS for one of your numbers. The number's real carrier capability is checked first: some number types can't do SMS at all (smsCapable: false), and a number still provisioning at the carrier returns notReady: true (try again once provisioning finishes).

US numbers additionally need a carrier registration before messages deliver; the response tells you which path applies:

  • alreadyRegistered: true: a prior registration still covers this number; SMS was simply reactivated.
  • reusable set: you have an approved registration this number can join in one click via POST /v1/phone-numbers/{id}/sms/reuse-registration (no new brand/campaign, no extra carrier fee).
  • needsRegistration: true and no reusable: start one via POST /v1/sms/registrations.

Idempotent: re-running re-attempts any carrier-side setup that failed.

post/v1/phone-numbers/{id}/sms

Path parameters

idstring required

Phone number record ID (from GET /v1/phone-numbers).

Response

Result. Check enabled: a 200 with enabled: false means the number can't do SMS (smsCapable: false) or isn't ready yet (notReady: true).

enabledboolean
idstring

The SMS social account ID (present when enabled).

phoneNumberstring
isActiveboolean

False for US numbers until their registration is approved.

countrystring
smsCapableboolean nullable

Null when capability can't be read yet (still provisioning).

mmsCapableboolean
domesticOnlyboolean
notReadyboolean

Number is still provisioning at the carrier; retry shortly.

needsRegistrationboolean

US only; a carrier registration is required before delivery.

alreadyRegisteredboolean

A prior non-rejected registration already covers this number; no re-submit needed.

registrationStatus'pending' | 'approved' | 'rejected' | 'null' nullable
messagestring

Human-readable explanation when enabled is false.