API reference › Service setup › Request statuses

Update an existing request status

PATCH /v1/request-statuses/{request_status}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Update an existing request status by ID.

Parameters

Path parameters

NameTypeDescription
request_status requiredinteger

ID of the request status to update.

Example 5.

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

Request body required

FieldTypeDescription
namestring

Example Updated request status.

descriptionstring or null

Example This is test description for updated request status..

parentobject or null
parent.idinteger

Example 1.

parent.labelstring

Example Pending.

Example

JSON
{
  "name": "Updated request status",
  "description": "This is test description for updated request status.",
  "parent": {
    "id": 1,
    "label": "Pending"
  }
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/request-statuses/{request_status}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Updated request status","description":"This is test description for updated request status.","parent":{"id":1,"label":"Pending"}}'

Try it

Responses

200 Request status updated successfully

Request status updated successfully.

JSON
{
  "success": true,
  "message": "Request status updated!",
  "data": {
    "id": 10,
    "name": "Updated request status",
    "description": "This is test description for updated request status.",
    "parent": {
      "id": 1,
      "label": "Pending"
    },
    "isCustom": true
  }
}
Response fields (10)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Request status updated!.

dataobject
data.idinteger

Example 10.

data.namestring

Example Updated request status.

data.descriptionstring

Example This is test description for updated request status..

data.parentobject
data.parent.idinteger

Example 1.

data.parent.labelstring

Example Pending.

data.isCustomboolean

Example true.

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Request status not found.

JSON
{
  "success": false,
  "message": "Request status with ID 10 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Request status with ID 10 not found..

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