API reference › General settings › Requirements and preferences
Update a specific field in requirement and preferences
PUT /v1/settings/update-requirement-field/{id}
- Scope
settings_general:edit- Roles
- admin, scheduler
Updates only the fields provided in the request for a requirement and preference entry.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
id required | integer | ID of the requirement_and_preference to update |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
skill_id | object | |
specialization_id | array of object |
Example
{
"skill_id": {
"id": 3,
"label": "Skill 3"
},
"specialization_id": [
{
"id": 2,
"label": "Spec 2"
}
]
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/settings/update-requirement-field/{id}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"skill_id":{"id":3,"label":"Skill 3"},"specialization_id":[{"id":2,"label":"Spec 2"}]}'Try it
Responses
200 Field(s) updated successfully
Field(s) updated successfully.
{
"success": true,
"message": "Requirement updated successfully.",
"data": {}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object |
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: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 |
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: |