curl -X POST https://api.open.cx/connect/threads/order_84421/participants \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" }'
{
"participant": { "id": "prt_d55", "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" },
"lanes": [
{ "id": "customer_merchant", "status": "active" },
{ "id": "customer_courier", "status": "active" }
]
}
Connect
Add a Connect participant
Add a participant to a thread — typically the courier at assignment time. Waiting lanes for their role activate automatically on join.
POST
/
connect
/
threads
/
{thread_id}
/
participants
curl -X POST https://api.open.cx/connect/threads/order_84421/participants \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" }'
{
"participant": { "id": "prt_d55", "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" },
"lanes": [
{ "id": "customer_merchant", "status": "active" },
{ "id": "customer_courier", "status": "active" }
]
}
Add a participant to an open thread. The standard use is adding the
courier at assignment — the customer_courier lane flips from waiting to active and the Supervisor briefs the courier with any context that matters (“leave at the gate, code 4411”).
A thread holds one active participant per role; adding a second courier returns 409 — remove the first for reassignment.
Path
string
required
Thread ID (
th_…) or your reference.Request
string
required
customer, merchant, or courier.string
required
Your ID for this person.
string
required
Name shown to other participants.
string
BCP-47 code for this participant’s reading language.
Response
object
The created participant with server ID (
prt_…).array
Updated lane states — the joining role’s lanes become
active.curl -X POST https://api.open.cx/connect/threads/order_84421/participants \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" }'
{
"participant": { "id": "prt_d55", "role": "courier", "external_id": "drv_318",
"display_name": "Aleksei", "language": "en" },
"lanes": [
{ "id": "customer_merchant", "status": "active" },
{ "id": "customer_courier", "status": "active" }
]
}
Was this page helpful?