API reference › Handshakes › Invitations to an assignment
Invite providers to an assignment
POST /v1/assignments/{id}/handshakes/invite
- Scope
handshakes:edit- Roles
- admin, scheduler
Creates a handshake per provider and dispatches invite notifications to each. Providers already invited to this assignment are skipped.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | string | Assignment ID. |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
providerIds required | array of string | Service provider IDs to invite. min items 1. |
Example
{
"providerIds": [
"SP-9F2K1A"
]
}Example request
curl -X POST "https://api.fetchfido.ai/v1/assignments/{id}/handshakes/invite" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"providerIds":["SP-9F2K1A"]}'Try it
Responses
201 Providers invited
Providers invited.
{
"success": true,
"message": "2 provider(s) invited successfully.",
"data": [
{}
]
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
422 Validation failed
Validation failed — providerIds is required and must contain at least one ID.
{
"success": false,
"message": "Unable to save. Please check the highlighted fields",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |