> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xenia.team/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Role

> Creates a new role in the specified workspace



## OpenAPI

````yaml POST /api/v1/mgt/workspaces/{workspaceId}/roles
openapi: 3.1.0
info:
  title: Xenia Team API - Create Role
  description: Create a new role within a specific workspace
  version: 1.0.0
servers:
  - url: https://api.xenia.team
security: []
paths:
  /api/v1/mgt/workspaces/{workspaceId}/roles:
    post:
      tags:
        - Roles
      summary: Create Role
      description: Creates a new role in the specified workspace
      parameters:
        - name: workspaceId
          in: path
          required: true
          description: Workspace ID where the role will be created
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewRole'
            examples:
              NewRoleExample:
                value:
                  title: New Role Title
                  description: New Role test description
                  permissions:
                    - dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7
                    - 7790c9eb-8d55-4fe0-a52d-2e5e769e9588
                  users:
                    - a437857a-463f-4ab7-997e-0e7b98e2b779
                    - 08c25f22-c894-4d9d-bba2-ced36b8191bd
                  reportTo: 43bc03d0-e0c5-41a1-bc13-2d232a40a728
                  homepage:
                    mobile: DEFAULT
                    web: DEFAULT
                    dashboard: {}
      responses:
        '200':
          description: Role created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Role'
                  meta:
                    type: object
              examples:
                example:
                  value:
                    data:
                      createdAt: '2025-06-22T11:38:55.045Z'
                      updatedAt: '2025-06-22T11:38:55.045Z'
                      id: 198a9961-c365-46d4-8962-7f9720f21fae
                      isActive: true
                      order: 1
                      title: New Role Title
                      description: New Role test description
                      editable: true
                      reportTo: 43bc03d0-e0c5-41a1-bc13-2d232a40a728
                      homepage:
                        mobile: DEFAULT
                        web: DEFAULT
                        dashboard: {}
                      workspaceId: cb363f7e-c52a-4478-911d-f6a6f791090e
                      createdBy: dfea8b8a-5b22-4668-b68d-dc641eb3a101
                      updatedBy: dfea8b8a-5b22-4668-b68d-dc641eb3a101
                      deletedAt: null
                    meta: {}
        '400':
          description: Bad Request - Invalid input or missing required fields
        '401':
          description: Unauthorized - Missing or invalid authentication
        '403':
          description: Forbidden - Insufficient permissions to create roles
        '404':
          description: Not Found - Workspace does not exist
        '409':
          description: Conflict - Role with this title already exists
        '500':
          description: Internal Server Error
      security:
        - clientKey: []
          clientSecret: []
components:
  schemas:
    NewRole:
      type: object
      required:
        - title
      properties:
        title:
          type: string
          description: Name of the role
        description:
          type: string
          description: Description of the role
        permissions:
          type: array
          items:
            type: string
            format: uuid
          description: List of permission IDs to assign to this role
        users:
          type: array
          items:
            type: string
            format: uuid
          description: List of user IDs to assign to this role
        reportTo:
          type: string
          format: uuid
          description: Role ID that this role reports to
        homepage:
          type: object
          properties:
            mobile:
              type: string
              description: Default mobile homepage
            web:
              type: string
              description: Default web homepage
            dashboard:
              type: object
              description: Dashboard configuration
    Role:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        description:
          type: string
        order:
          type: integer
        editable:
          type: boolean
        isActive:
          type: boolean
        reportTo:
          type: string
          format: uuid
        homepage:
          type: object
          properties:
            mobile:
              type: string
            web:
              type: string
            dashboard:
              type: object
        workspaceId:
          type: string
          format: uuid
        createdBy:
          type: string
          format: uuid
        updatedBy:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
          nullable: true
  securitySchemes:
    clientKey:
      type: apiKey
      in: header
      name: x-client-key
      description: Client API key for authentication
    clientSecret:
      type: apiKey
      in: header
      name: x-client-secret
      description: Client secret for authentication

````