Archive or unarchive a master custom field
POST /v1/forms/fields/{fieldId}/{action}
- Scope
forms:edit- Roles
- admin, scheduler
Sets the master field's archived status per the action path segment: 'archive' hides it from the field picker/new placements, 'unarchive' restores it.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
fieldId required | integer | Master field id (form_fields.id) |
action required | string | Whether to archive or unarchive the field One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl -X POST "https://api.fetchfido.ai/v1/forms/fields/{fieldId}/{action}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Archive status updated
Archive status updated
{
"success": true,
"message": "Custom field archived.",
"data": {
"fieldId": 1,
"fieldKey": "full_name",
"isArchived": true
}
}Response fields (6)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.fieldId | integer | Example |
data.fieldKey | string | Example |
data.isArchived | 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 'forms: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
The specified field does not exist.
{
"success": false,
"message": "The requested resource could not be found.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. 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: |