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

NameTypeDescription
id requiredstring

Assignment ID.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

FieldTypeDescription
providerIds requiredarray of string

Service provider IDs to invite.

min items 1.

Example

JSON
{
  "providerIds": [
    "SP-9F2K1A"
  ]
}

Example request

Shell
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.

JSON
{
  "success": true,
  "message": "2 provider(s) invited successfully.",
  "data": [
    {}
  ]
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example 2 provider(s) invited successfully..

dataarray of object
401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'handshakes:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed — providerIds is required and must contain at least one ID.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.