Roles

Delete a custom role

Changed on

Deletes one of the organization's custom roles and returns 204. A role still held by a member is refused with 409 ROLE_IN_USE. Requires a signed-in session.

Requires the role.manage permission. See Permissions for the roles and API key permissions that include it.

delete/v1/roles/{roleId}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/roles/{roleId}
  • Auth
    HTTP bearer

Path parameters

roleIdstring required

Response

Deleted

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 551a288b9aa0Revision changes
    • breaking

      removed the required property from the response with the status