Skip to main content
POST
Send a one-time code

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
phone
string

Recipient phone in E.164 format, e.g. +5215512345678.

Minimum string length: 1
personExternalId
string

Your own ID for the person; Boom uses their stored phone.

Minimum string length: 1
reference
string

Your label for what the code is for, e.g. an appointment ID. People sharing a phone get separate codes when this or personExternalId is passed.

Maximum string length: 255

Response

Success

otpId
string
required

Pass this to otp_verify.

status
string
required
Allowed value: "PENDING"
expiresAt
string
required

ISO 8601 timestamp.

resent
boolean
required

True when an existing valid code was sent again.

reference
string | null
required
personExternalId
string | null
required