API reference › Forms

Archive or unarchive a field placement on a form

POST /v1/forms/{formCode}/group-fields/{groupFieldId}/{action}

Scope
forms:edit
Roles
admin, scheduler

Sets a field placement's archived status on this specific form only (the master field and its placements on other forms are unaffected), per the action path segment: 'archive' or 'unarchive'.

Parameters

Path parameters

NameTypeDescription
formCode requiredstring

Form code (FRM-…)

Example FRM-XYZ123.

groupFieldId requiredinteger

Field placement id (form_group_fields.id)

action requiredstring

Whether to archive or unarchive the placement

One of: archive, unarchive.

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

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/forms/{formCode}/group-fields/{groupFieldId}/{action}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Archive status updated

Archive status updated

JSON
{
  "success": true,
  "message": "Field archived on this form.",
  "data": {
    "id": 5,
    "isArchived": true
  }
}
Response fields (5)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Field archived on this form..

dataobject
data.idinteger

Example 5.

data.isArchivedboolean

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

The specified field does not exist on this form.

JSON
{
  "success": false,
  "message": "The requested resource could not be found.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The requested resource could not be found..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

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.