Skip to main content
DELETE
/
api
/
v1
/
roles
/
{role_id}
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.roles.delete({
    roleId: 458987,
    reason: "<value>",
  });

  console.log(result);
}

run();
{
  "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