Skip to main content
POST
Enroll a contact in a workflow

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.

Path Parameters

workflow_id
string
required
Pattern: ^workflow_[A-Za-z0-9_-]+$
Example:

"workflow_abc123"

Body

application/json
contact_id
string
required
Pattern: ^contact_[A-Za-z0-9_-]+$
Example:

"contact_abc123"

request_id
string
required

Your unique ID for this enrollment. Sending the same request_id again returns the original result instead of enrolling the contact twice.

Required string length: 1 - 200
Example:

"enroll-order-4821"

metadata
object

Optional context about the enrollment. Up to 20 keys, each a string (up to 500 characters), number, boolean or null, and 4,096 bytes in total.

Response

This request_id was already used, or no new run started. Check enrollment_status and no_op_reason.

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.