API reference › Forms

Remove a user/location/finance record from a form's Assign To list

DELETE /v1/forms/{formCode}/assigned-users/{assignedUserId}/{option}

Scope
forms:edit
Roles
admin, scheduler

'removeOnly' soft-deletes the assignment row only — previously submitted data stays intact on the subject's record as historical data. 'permanentlyRemove' (alias 'removeAndDelete', the value the admin screen sends) additionally purges that subject's stored data for this form and hard-deletes the assignment row.

Parameters

Path parameters

NameTypeDescription
formCode requiredstring

Form code (FRM-…)

Example FRM-XYZ123.

assignedUserId requiredinteger

form_assigned_users.id

option requiredstring

removeOnly unassigns the user; permanentlyRemove also deletes their historical submissions. removeAndDelete is accepted as an alias of permanentlyRemove.

One of: removeOnly, permanentlyRemove, removeAndDelete.

Query parameters

NameTypeDescription
reasonstring

Optional note, max 500 characters, recorded in the audit entry when submissions are deleted. May also be sent in the body.

max length 500.

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

Example request

Shell
curl -X DELETE "https://api.fetchfido.ai/v1/forms/{formCode}/assigned-users/{assignedUserId}/{option}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID"

Try it

Responses

200 Assignment removed

Assignment removed

JSON
{
  "success": true,
  "message": "User removed from form assignment."
}
Response fields (2)
FieldTypeDescription
successboolean

Example true.

messagestring

Example User removed from form assignment..

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 assignment 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 .

422 Validation failed

option is not removeOnly, permanentlyRemove or removeAndDelete.

JSON
{
  "status": "error",
  "message": "Unable to save. Please check the highlighted fields",
  "errors": {
    "name": [
      "Please enter a name."
    ],
    "email": [
      "The email has already been taken."
    ]
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example Unable to save. Please check the highlighted fields.

errorsobject

Field name to its messages. Nested keys are collapsed onto the field the form renders.

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.