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

# Create a team

> Creates a team with you as its creator, in the built-in مالک role. The team starts with the built-in roles, and with your email address and phone number as notification channels. Your account must be verified.



## OpenAPI

````yaml /spec/platform-teams.yaml post /v2/teams
openapi: 3.0.1
info:
  title: Teams & Access
  version: 1.0.0
  description: >
    Create teams, invite people, and control what each member can do.


    A team is a separate account that owns its own resources and billing.

    Members work on the team's resources with their own API token by adding

    `teamID` to their requests. Access comes from two places:


    - **Role permissions** apply across the whole team. Every member has
      exactly one role.
    - **Resource permissions** give one member access to one specific
      resource, such as a single app or database.

    A request is allowed if either source grants a required permission.


    Every team starts with these built-in roles:


    | Role | Permissions |

    |------|-------------|

    | مالک | `manage` and `create` on every resource type, plus `billing.manage`
    and `team.manage`. The team creator always has this role. |

    | مدیر | `manage` and `create` on every resource type |

    | گرداننده | `operate` on every resource type |

    | بازرس | `view` on every resource type |

    | حسابدار | `billing.manage` |

    | مهمان | No permissions |


    The number of members, custom roles and resource permissions per team,

    and the number of teams per user, are limited.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Teams
    description: Create, list, rename and delete teams.
  - name: Invitations
    description: Invite people to a team and accept invitations.
  - name: Members
    description: List members, remove them, change their role, or leave a team.
  - name: Roles
    description: List roles and manage custom roles.
  - name: Resource Permissions
    description: Give members access to specific resources.
paths:
  /v2/teams:
    post:
      tags:
        - Teams
      summary: Create a team
      description: >-
        Creates a team with you as its creator, in the built-in مالک role. The
        team starts with the built-in roles, and with your email address and
        phone number as notification channels. Your account must be verified.
      operationId: createTeam
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - color
              properties:
                name:
                  type: string
                  minLength: 3
                  maxLength: 50
                  description: >-
                    Team name. Leading and trailing spaces are removed. It can't
                    be `حساب شخصی`.
                color:
                  $ref: '#/components/schemas/TeamColor'
            example:
              name: my-team
              color: CARBON_SEA
      responses:
        '200':
          description: The team was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamSummary'
              example:
                _id: '000000000000000000000002'
                name: my-team
                color: CARBON_SEA
        '400':
          description: >-
            The body is invalid, or you've reached the maximum number of teams
            (`max_teams_reached`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 400
                error: Bad Request
                message: Max teams reached
                data:
                  code: max_teams_reached
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountVerificationRequired'
        '409':
          description: You already created a team with this name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 409
                error: Conflict
                message: Team already exists
                data:
                  code: team_already_exists
components:
  schemas:
    TeamColor:
      type: string
      enum:
        - PURPLE_FIRE
        - GOLDEN_NATURE
        - WOLF_AND_MIST
        - CARBON_SEA
        - WINTER_FOG
        - RED_SEA
    TeamSummary:
      type: object
      properties:
        _id:
          type: string
          description: The team's ID. Pass it as `teamID`.
        name:
          type: string
        color:
          $ref: '#/components/schemas/TeamColor'
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    AccountVerificationRequired:
      description: >-
        Your account isn't verified yet. Set your full name and verify your
        email address, phone number and national code first.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            error: Forbidden
            message: You must verify your account, first.
            data:
              code: account_verification_required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.