API Reference
API Reference

Delete Role

Delete a role. Optionally, reassign existing users with that role to a new role.

DELETE/api/v1/roles/{role_id}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

role_id integer path required

The ID of the role to delete

Query parameters

reason string query required

The reason for deleting the role

new_role_id integer | null query optional

Users with the deleted role will be reassigned to the new role, if a new role ID is provided

Responses

200Successful Response

application/json

response unspecified required
Response example
string
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}