API reference › Providers › Provider portal

Confirm an assignment for a service provider

PUT /v1/dashboard/provider-portal/assignment-confirm/{id}/{assignmentId}

Scope
providers:edit
Roles
service-provider

Confirms an assignment for a service provider based on assignment ID and slot ID.

Parameters

Path parameters

NameTypeDescription
id requiredinteger

ID

Example 162.

assignmentId requiredstring

Assignment or Shift ID (as per system design)

Example ASG-X9C9WG.

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

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/dashboard/provider-portal/assignment-confirm/{id}/{assignmentId}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment confirmed successfully

Assignment confirmed successfully

JSON
{
  "success": true,
  "message": "Assignment confirmed successfully"
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment confirmed successfully.

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 'providers: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 'providers:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment not found

JSON
{
  "success": false,
  "message": "Assignment not found",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Assignment not found.

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

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.