API reference › General settings › Statuses
Create a new status
POST /v1/status
- Scope
settings_general:write
Create a new status with a name and optional tenant ID.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name required | string | Example |
tenant_id required | string | Example |
Example
{
"name": "New Status",
"tenant_id": "demotenant"
}Example request
curl -X POST "https://api.fetchfido.ai/v1/status" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"New Status","tenant_id":"demotenant"}'Try it
Responses
201 Status created successfully
Status created successfully
{
"success": true,
"message": "Status created!",
"data": {
"id": 1,
"value": 1,
"label": "Example label",
"isCustom": true
}
}Response fields (7)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.value | integer | Example |
data.label | string | Example |
data.isCustom | boolean | Example |
400 Bad request
Validation failed.
{
"status": "error",
"message": "The name field is required."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | 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_general:write' 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 |
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
Server error.
{
"status": "error",
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |