Skip to main content
POST
Node.js

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer rw_....

Required scope: project:write.

Body

application/json
phone
string
required

Destination number stored in E.164 format after normalization.

Minimum string length: 8
Example:

"+5511999999999"

name
string

Optional human-readable label used to look up the contact later.

Required string length: 1 - 80
Example:

"Fernanda"

channel
enum<string>

Optional preferred channel for future contact-based sends.

Available options:
SMS,
OTP
Example:

"SMS"

tagIds
string[]

Optional tag identifiers attached to the contact on creation.

Maximum array length: 15
Example:
tags
object

Arbitrary metadata stored with the contact.

preferredLanguages
string[]

Preferred locale codes used when targeting this contact with localized flows.

Example:

Response

200 - application/json

Successful response

ok
boolean
required
data
object
required