API reference › Requests › Provider portal

Decline a request assignment by ID

PATCH /v1/portal/provider/requests/assignment-decline/{id}/{status}

Scope
requests:edit
Roles
service-provider

Returns decline assignment ID

Parameters

Path parameters

NameTypeDescription
id requiredstring

The ID of the assignment entry

Example ASG-JSPYP1.

status requiredstring

How the provider is turning the request down.

One of: declined, not_interested. Example declined.

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

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/portal/provider/requests/assignment-decline/{id}/{status}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment decline successfully

Assignment decline successfully

JSON
{
  "success": true,
  "message": "Assignment decline successfully.",
  "data": {
    "id": "ASG-JSPYP1"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Assignment decline successfully..

dataobject
data.idstring

Example ASG-JSPYP1.

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Assignment entry not found

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

Example false.

messagestring

Example Assignment entry not found..

errorsstring
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

Server error

JSON
{
  "success": false,
  "message": "Something went wrong!",
  "errors": "Unexpected error occurred."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Unexpected error occurred..