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

# Create Role

`POST /roles`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/roles`
- Auth: HTTP bearer

Define a new role. It grants nobody anything until it is assigned.

Two of the app's own guards run inside the handler and are not duplicated
here: `_assert_can_grant_permissions` refuses a permission the CALLER does
not hold, and `_require_teams_manage` refuses `manages_role_slugs` without
`teams:manage`. Both reach the caller as a 403 with the app's own message.

This is `write` rather than `destructive` on purpose: a brand-new role is
held by no one, so creating it changes nobody's access. Editing one does -
which is why `PUT /roles/{role_id}` is tiered differently.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- RoleCreateRequest: Define a new role. Mirrors `roles.RoleCreateRequest`. `permissions` is bounded by the app's own non-escalation guard (`_assert_can_grant_permissions`): a caller may not mint a role granting a permission they do not themselves hold. That guard runs INSIDE the handler and is deliberately not duplicated here - see the router docstring.
  - `name` string, required
  - `slug` string, required
  - `description` string, nullable
  - `permissions` string[]
  - `manages_role_slugs` string[], nullable
  - `rep_limits` RepLimitsSettings: Per-role reveal/ownership limits. Mirrors `roles.RepLimitsSettings`. The three `Literal`s are closed here rather than left as strings because they reach the app's own `Literal` inside `_apply_rep_limits`.
    - `max_contacts` integer, nullable
    - `max_companies` integer, nullable
    - `conflict_company_owned` 'allow' | 'warn' | 'block'
    - `conflict_contact_active` 'allow' | 'warn' | 'block'
    - `reveal_policy` 'within_limits' | 'monthly_credit_budget' | 'no_limit'
    - `reveal_monthly_credit_budget` integer, nullable

## Response `201`

Successful Response

- ApiResponseOrgPayload
  - `data` OrgPayload, required: An open envelope for a single role, team, member or account record. Open on purpose. The app's own response models on this surface grow with the product - `RoleResponse` gained `rep_limits` and `manages_role_slugs`, `TeamResponse` gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as "they do not have it".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/d377a703be15?raw)