Skip to main content
POST
Check iMessage, RCS or SMS support

Authorizations

Authorization
string
header
required

Your workspace API key, sent as Authorization: Bearer blu_.... Workspace admins can find it in the Blujay app under API.

An API key has full access to your workspace and works on every endpoint. There is no test mode: every key sends real messages and changes real data, so keep it secret and use it only from your server.

Each API key can make 600 read requests and 120 write requests per minute, plus 60 attachment requests per minute. Over a limit you get 429 RATE_LIMIT_EXCEEDED with Retry-After.

Body

application/json

from_phone_number_id is optional only when your workspace has exactly one active number. With more than one, leave it out and you get 400 PHONE_NUMBER_REQUIRED; send it to choose the number.

number
string
required

The US phone number to check.

Example:

"+15555550123"

from_phone_number_id
string
Pattern: ^phone_[A-Za-z0-9_-]+$
Example:

"phone_abc123"

Response

The service Blujay would use.

Wraps every successful response. The result is in data.

status
enum<string>
required
Available options:
success
trace_id
string
required
Pattern: ^trc_[A-Za-z0-9_-]+$
Example:

"trc_8f2a1c0e4b7d"

timestamp
string<date-time>
required
Example:

"2026-10-14T17:01:00.000Z"

data
object
required
client_request_id
string

Your X-Request-ID header value, echoed back when you send one. Not included on the send responses (POST /v1/chats, POST /v1/chats/{chat_id}/messages, POST /v1/messages/{message_id}/retry); keep your own mapping from your request ID to the returned message ID there.