Skip to main content
DELETE
/
api
/
v1
/
roles
/
{role_id}
Python (SDK)
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.roles.delete(role_id=458987, reason="<value>")

    # Handle response
    print(res)
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key
string
header
required

Path Parameters

role_id
integer
required

The ID of the role to delete

Query Parameters

reason
string
required

The reason for deleting the role

new_role_id
integer | null

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

Response

Successful Response