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
| Name | Type | Description |
|---|---|---|
formCode required | string | Form code (FRM-…) Example |
assignedUserId required | integer | form_assigned_users.id |
option required | string | removeOnly unassigns the user; permanentlyRemove also deletes their historical submissions. removeAndDelete is accepted as an alias of permanentlyRemove. One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
reason | string | 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
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
{
"success": true,
"message": "User removed from form assignment."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | 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 '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 assignment does not exist on this form.
{
"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 |
422 Validation failed
option is not removeOnly, permanentlyRemove or removeAndDelete.
{
"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)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | 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.
{
"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: |