API reference › Service setup › Assignment statuses
Update an existing assignment status
PATCH /v1/assignment-statuses/{assignment_status}
- Scope
settings_service_setup:edit- Roles
- admin, scheduler
Update an existing assignment status by ID.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
assignment_status required | integer | ID of the assignment status to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name | string | Example |
description | string or null | Example |
parent | object or null | |
parent.id | integer | Example |
parent.label | string | Example |
Example
{
"name": "Updated assignment status",
"description": "This is test description for updated assignment status.",
"parent": {
"id": 1,
"label": "Pending"
}
}Example request
curl -X PATCH "https://api.fetchfido.ai/v1/assignment-statuses/{assignment_status}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Updated assignment status","description":"This is test description for updated assignment status.","parent":{"id":1,"label":"Pending"}}'Try it
Responses
200 Assignment status updated successfully
Assignment status updated successfully.
{
"success": true,
"message": "Assignment status updated!",
"data": {
"id": 10,
"name": "Updated assignment status",
"description": "This is test description for updated assignment status.",
"parent": {
"id": 1,
"label": "Pending"
},
"isCustom": true
}
}Response fields (10)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.name | string | Example |
data.description | string | Example |
data.parent | object | |
data.parent.id | integer | Example |
data.parent.label | string | Example |
data.isCustom | boolean | Example |
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 'settings_service_setup: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 |
404 Not found
Assignment status not found.
{
"success": false,
"message": "Assignment status with ID 10 not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | 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: |
500 Server error
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |