Skip to navigation
API Referencenumbers

Create Number

Provision a new phone number from the account’s configured SMS provider (or an iMessage line with type=imessage). Optional externalId tags the number with your own identifier; see PATCH /v1/numbers/{id}.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Sub-Account-IdstringOptional

Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.

Request

This endpoint expects an object.
countrystringOptionalDefaults to US
areaCodestring or nullOptional
agentIdstring or nullOptional
externalIdstring or nullOptional
typeenum or nullOptional
Allowed values:
imessageTypeenum or nullOptional
Allowed values:

Response

Successful Response
idstring
phoneNumberstring
countrystring
statusstring
createdAtdatetime
typestringOptionalDefaults to sms
agentIdstring or nullOptional
outboundSmsenumOptionalDefaults to enabled
Allowed values:
inboundCallsEnabledbooleanOptionalDefaults to true
readReceiptsEnabledbooleanOptionalDefaults to true
whatsappEnabledbooleanOptionalDefaults to false
dailyNewContactsobject or nullOptional
externalIdstring or nullOptional
purchasedAtdatetime or nullOptional

Errors

422
Unprocessable Entity Error