Skip to content
Primary navigation

Delete organization role

admin.organization.roles.delete(role_id) -> RoleDeleteResponse { id, deleted, object }
DELETE/organization/roles/{role_id}

Deletes a custom role from the organization.

ParametersExpand Collapse
role_id: String
ReturnsExpand Collapse
class RoleDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a role.

id: String

Identifier of the deleted role.

deleted: bool

Whether the role was deleted.

object: :"role.deleted"

Always role.deleted.

Delete organization role

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

role = openai.admin.organization.roles.delete("role_id")

puts(role)
{
    "object": "role.deleted",
    "id": "role_01J1F8ROLE01",
    "deleted": true
}
Returns Examples
{
    "object": "role.deleted",
    "id": "role_01J1F8ROLE01",
    "deleted": true
}