Create a assignment

POST

/v1/projects/{projectId}/collection-orders/{orderId}/assignments

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/assignments' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "collectorMembershipId": "00000000-0000-0000-0000-000000000000",
    "taskId": "00000000-0000-0000-0000-000000000000"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired

Header parameters

Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

Request body

Content-Typeapplication/json

collectorMembershipIdstring (uuid)required
taskIdstring (uuid) | null

Responses

Success

dataobjectrequired
- idstringrequired
- orderIdstringrequired
- taskIdstring | nullrequired
- collectorMembershipIdstringrequired
- collectorNamestring | nullrequired
- statusstringrequired
  Allowed values
  active
  removed
- assignedBystring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired

Response example

{
  "data": {
    "id": "string",
    "orderId": "string",
    "taskId": "string",
    "collectorMembershipId": "string",
    "collectorName": "string",
    "status": "active",
    "assignedBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1