Members, roles and audit logDelete a role

Members, roles and audit log

Delete a role

DEL/v1/roles/{id}

Deletes a role that no member is on.

Move every member on the role to another role first with Update a member; while members are on it the call fails with role_in_use. The Owner role can never be deleted (role_locked). Presets can be deleted too, but if you only want their default keys back, use Reset a role.

A Team feature. The body must contain "confirm": true, and the deletion is audited.

Needs confirmation

This action is destructive or moves money. Send "confirm": true in the body; without it you get 428 confirmation_required and a preview of what would happen. See Drafts and confirmations.

Permission
team.manage
Type
Destructive or money-moving. Needs "confirm": true (or a confirmation in the app).
Auth
API key, MCP token or signed-in session
Capability
delete_role
CLI
freeinvoiceautomation role delete
Available
At launch, 1 January 2027
delete_role
curl --request DELETE \
  --url https://api.freeinvoiceautomation.com/v1/roles/<id> \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: <unique-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "confirm": true
}'
No content

Authorizations

Authorizationstringrequired
Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Headers

Idempotency-Keystring
Any unique string up to 255 characters. Required for API-key and MCP calls that create something; optional otherwise. See Idempotency.

Path Parameters

idstring<uuid>required
Id of the role.

Body

application/json
confirmbooleanrequired
Must be true. Without it the call changes nothing and returns 428 confirmation_required with a preview of what would happen. See Drafts and confirmations.

Errors

Plus the common errors every call can return. See Errors.