Skip to main content
POST
Enroll a subject in this journey

Authorizations

Authorization
string
header
required

Company secret API key.

Headers

X-Woku-Idempotency-Key
string

Client-generated key to make the call safe to retry. A retry with the same key and operation returns the original result instead of acting again. Do not reuse it for new input: retries replay the original body. A different operation returns 422.

Path Parameters

id
string<ObjectId>
required

Body

application/json
subjectKey
string
required

Your own key for who is enrolled: a customer id, an order, a ticket.

Example:

"cliente-123"

contact
object
required

Where to reach the subject. At least one of email or phone.

authHeader
string
deprecated
write-only

Legacy body API key. Prefer Authorization: Bearer. Consumed by authentication and never forwarded to journey commands.

trackers
object[]
metadata
object

Anything you want kept with it

Response

The subject was enrolled

subjectKey
string
required
journeyId
string
required