---
title: "Create Custom Role"
method: POST
path: "/custom_role"
tags: ["Custom Roles"]
---

# Create Custom Role

`POST /custom_role`

This endpoint enables you to create custom roles for organizations within your scope.

## Query parameters

- `org_id` integer

## Request body

- CustomRoleCreationBody — Custom role creation payload.
  - `name` string, required — Name of the Custom Role. Cannot contain any of the following characters: `,;/\|<>`.
  - `api_id` string, required — Unique identifier. Cannot contain any of the following characters: `,;/\|<>`.
  - `description` string — Description of the Custom Role. Cannot contain any of the following characters: `,;/\|<>`.
  - `permissions` string[], required — List of permission names. (Use GET `/api/v2/permissions` to get a list of all available permissions for your organization.)
  - `org_id` integer — Unique identifier of an organization in Partoo.

## Response `200`

OK

- CustomRoleCreationResponse — Response returned when a custom role is successfully created.
  - `status` 'success' — Request status
  - `api_id` string — API identifier of the created custom role.

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action
- `404` — Resource does not exist

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)