API Reference

Admin

Organization

Projects

Roles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete project role

client.admin.organization.projects.roles.delete(stringroleID, RoleDeleteParams { project_id } params, RequestOptionsoptions?): RoleDeleteResponse { id, deleted, object }

DELETE/projects/{project_id}/roles/{role_id}

Deletes a custom role from a project.

ParametersExpand Collapse

roleID: string

params: RoleDeleteParams { project_id }

project_id: string

The ID of the project to update.

ReturnsExpand Collapse

RoleDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a role.

id: string

Identifier of the deleted role.

deleted: boolean

Whether the role was deleted.

object: "role.deleted"

Always role.deleted.

Delete project role

TypeScript

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const role = await client.admin.organization.projects.roles.delete('role_id', {
  project_id: 'project_id',
});

console.log(role.id);

{
    "object": "role.deleted",
    "id": "role_01J1F8PROJ",
    "deleted": true
}

Returns Examples

{
    "object": "role.deleted",
    "id": "role_01J1F8PROJ",
    "deleted": true
}