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

# Add a user to an organisation

> Adds an existing user to an organisation, so that they can act on its behalf



## OpenAPI

````yaml https://api.zapnito.com/api/docs/v1/swagger.json post /api/v1/organisations/{organisation_id}/users
openapi: 3.0.1
info:
  title: API V1
  version: v1
  description: Zapnito API Documentation
servers:
  - url: https://{host}
    description: Your community domain
    variables:
      host:
        default: your-community.com
        description: Your community domain, for example your-community.com
security: []
tags:
  - name: Health Check
    description: Check that the API is reachable and that your API key is valid
  - name: Identity
    description: Find out which community your API key belongs to
  - name: Users
    description: >-
      Look up the people in your community, update their profile and choose
      which notifications they receive
  - name: Organisations
    description: >-
      Create and update the organisations in your community and manage who
      belongs to them
  - name: Groups
    description: Create groups and manage which users belong to them
  - name: Invitations
    description: Invite people to join your community
  - name: Posts
    description: Create, read and update posts on behalf of your community members
  - name: Contents
    description: >-
      Read the published content of your community and publish, schedule or
      unpublish it
  - name: Channels
    description: List the channels in your community and the content published in each
  - name: Rooms
    description: Create and read the rooms where your community members meet
  - name: Tags
    description: Create tags and apply them to content
  - name: Badges
    description: Create badges and award them to content or to users
  - name: Custom Fields
    description: Read the custom profile fields your community asks its members to fill in
  - name: Third-Party Resources
    description: >-
      Link to resources hosted outside your community so they appear alongside
      your content
  - name: Rest Hooks
    description: >-
      Subscribe a URL to events in your community, so you are told when they
      happen
paths:
  /api/v1/organisations/{organisation_id}/users:
    parameters:
      - name: organisation_id
        in: path
        required: true
        description: The ID of the organisation
        schema:
          type: integer
    post:
      tags:
        - Organisations
      summary: Add a user to an organisation
      description: >-
        Adds an existing user to an organisation, so that they can act on its
        behalf
      operationId: addUserToOrganisation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganisationUserAddRequest'
        required: true
        description: Payload wrapped in a user object
      responses:
        '200':
          description: The user was added to the organisation, or already belonged to it
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: User 'jane@example.com' added to organisation with ID 12
                  errors:
                    type: string
                    example: >-
                      User 'jane@example.com' already belongs to organisation
                      with ID 12
                    description: >-
                      Present instead of message when the user is already a
                      member of the organisation
        '400':
          description: The user object is missing. The response has no body
        '401':
          description: >-
            The API key is missing or invalid. The response body is the text
            `HTTP Token: Access denied.`
        '404':
          description: No organisation has the ID, or no user has the email address
          content:
            application/json:
              examples:
                error:
                  value:
                    error: 'Organisation not found for ID: ''999'''
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: 'Organisation not found for ID: ''999'''
                required:
                  - error
      security:
        - tokenAuth: []
components:
  schemas:
    OrganisationUserAddRequest:
      type: object
      properties:
        user:
          type: object
          properties:
            email:
              type: string
              format: email
              example: jane@example.com
            owner:
              type: boolean
              example: false
              description: >-
                Set to true to make the user an owner of the organisation.
                Defaults to false
          required:
            - email
      required:
        - user
  securitySchemes:
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        API authentication using your community API secret. The value below is
        sent as the Authorization header verbatim, so paste the whole header
        value including the prefix: Token token=<api-key>
      x-default: Token token=<api-key>

````

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