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

# Create a role

> Creates a role in a organization



## OpenAPI

````yaml post /roles
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /roles:
    post:
      tags:
        - Roles
      summary: Create
      description: Creates a role in a organization
      operationId: roles#create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requestBodyRoleCreate'
            examples:
              example:
                $ref: '#/components/examples/requestRoleExample'
      responses:
        '201':
          description: successful
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/roleExample'
              schema:
                $ref: '#/components/schemas/roleModel'
      security:
        - apiKey: []
components:
  schemas:
    requestBodyRoleCreate:
      type: object
      properties:
        name:
          type: string
        key:
          type: string
        permissions:
          type: object
          nullable: true
    roleModel:
      type: object
      properties:
        id:
          type: integer
        key:
          type: string
        name:
          type: string
        organization_id:
          type: integer
        permissions:
          type: object
          nullable: true
          properties:
            projects_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            projects_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            projects_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            projects_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            voice_cloning_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            voice_cloning_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            voice_cloning_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            voice_cloning_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            members_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            members_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            members_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            members_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organizations_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organizations_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            roles_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            roles_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            roles_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            roles_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            content_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            content_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            content_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            content_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            background_tracks_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            background_tracks_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            background_tracks_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            background_tracks_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            html_filters_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            html_filters_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            html_filters_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            html_filters_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            rules_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            rules_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            rules_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            rules_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            summarization_settings_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            summarization_settings_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            video_settings_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            video_settings_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organizations_analytics:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            projects_analytics:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            content_analytics:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            ads_analytics:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            integrations_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            integrations_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            integrations_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            integrations_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            player_settings_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            player_settings_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            playlists_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            playlists_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            playlists_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            playlists_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            project_members_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            project_members_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            project_members_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            ads_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            ads_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            ads_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            ads_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organization_voices_view:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organization_voices_create:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organization_voices_update:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organization_voices_delete:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
            organization_voices_clone:
              type: object
              nullable: true
              properties:
                enabled:
                  type: boolean
        members_count:
          type: integer
        created:
          type: string
          description: Time at which the object was created (ISO 8601)
        updated:
          type: string
          description: Time at which the object was updated (ISO 8601)
  examples:
    requestRoleExample:
      summary: Sample creation of a role
      value:
        name: New role
        permissions:
          content_view:
            enabled: false
          content_create:
            enabled: false
    roleExample:
      summary: A sample role response
      value:
        id: 1
        key: owner
        name: Owner
        organization_id: 1
        permissions:
          content_view:
            enabled: true
          content_create:
            enabled: false
        created: 2023-01-01 00:00:00 UTC
        updated: 2023-01-01 00:00:05 UTC
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````