---
title: "Invite base members"
method: POST
path: "/api/v3/meta/bases/{baseId}/members"
tags: ["Base Members"]
---

# Invite base members

`POST /api/v3/meta/bases/{baseId}/members`

## Request

- Base URL: `https://app.nocodb.com`
- URL: `https://app.nocodb.com/api/v3/meta/bases/{baseId}/members`
- Auth: one of:
  - API key in header `xc-token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/nocodb/apis/nocodb-v3/docs/api/v3/meta/bases/:baseId/members/post.ts> (a function with typed inputs; its response is checked against the schema)

Invite new members to a specific base using their User ID or Email address.

Notes: Base collaboration APIs are available on cloud-hosted **Business** plans and above, and on licensed self-hosted deployments (**Business** plan and above).

## Path parameters

- `baseId` string, required

## Request body

- union[]: Array of members to be created.
  - union: An object representing a new member to be created.
    - object
      - `base_role` 'owner' | 'creator' | 'editor' | 'viewer' | 'commenter' | 'no-access', required: Base roles for the user. These are the values accepted when granting a role.
      - `user_id` string, required: Unique identifier for the user (skip if email is provided)
      - `user_name` string: Full name of the user.
    - object
      - `base_role` 'owner' | 'creator' | 'editor' | 'viewer' | 'commenter' | 'no-access', required: Base roles for the user. These are the values accepted when granting a role.
      - `email` string, email, required: Email address of the user (skip if user_id is provided)
      - `user_name` string: Full name of the user.

## Response `200`

Users invited successfully.

- BaseMember[]: List of successfully invited users.
  - `user_id` string, required: Unique identifier for the user.
  - `email` string, email, required: Email address of the user.
  - `display_name` string: Display name of the user.
  - `created_at` string, date-time, required: Timestamp of when the user was added to the base.
  - `updated_at` string, date-time, required: Timestamp of when the membership was last updated.
  - `base_role` 'owner' | 'creator' | 'editor' | 'viewer' | 'commenter' | 'no-access' | 'inherit' | 'app-user', required: Base role as reported on a member read. A superset of `BaseRoles`: `inherit` means the role comes from the workspace rather than the base, and `app-user` is an external app-only collaborator with no ambient base access. Neither can be assigned — they are never valid in a request body.

## Other responses

- `400`: Invalid request body or parameters.
- `404`: Base not found.
- `500`: Server error.

---

[API](https://skmtc.dev/nocodb/apis/nocodb-v3.md) - [All operations](https://skmtc.dev/nocodb/apis/nocodb-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/nocodb/apis/nocodb-v3/revisions/62a735aaf849?raw)