API Reference

Roles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create

client.roles.create(RoleCreateParams { role } body, RequestOptionsoptions?): RoleCreateResponse { data }

POST/roles

Creates a new role

ParametersExpand Collapse

body: RoleCreateParams { role }

role: string

Name of the role

ReturnsExpand Collapse

RoleCreateResponse { data }

data: Data { id, role }

Role object

id: string

Unique role ID

role: string

Name of the role

Create

TypeScript

HTTP

TypeScript

Python

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const role = await client.roles.create({ role: 'admin' });

console.log(role.data);

200 example

{
  "data": {
    "id": "role_abc123",
    "role": "admin"
  }
}

Returns Examples

200 example

{
  "data": {
    "id": "role_abc123",
    "role": "admin"
  }
}