Create a invitation
POST
/v1/projects/{projectId}/collection-orders/{orderId}/assignments/invitationscurl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/assignments/invitations' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"email": "user@example.com",
"emails": [
"user@example.com"
],
"csvText": "string",
"taskId": "00000000-0000-0000-0000-000000000000"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
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
- emailstring (email)
- emailsarray<string (email)>
- csvTextstring
- taskIdstring (uuid) | null
Responses
Success
- dataobjectrequired
- assignedarray<CollectionAssignmentDto>required
- invitedarray<object>required
Response example
{
"data": {
"assigned": [
{
"id": "string",
"orderId": "string",
"taskId": "string",
"collectorMembershipId": "string",
"collectorName": "string",
"status": "active",
"assignedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
],
"invited": [
{
"email": "string",
"invitationId": "string"
}
]
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1