---
title: "Add users to workspace"
method: POST
path: "/workspaces/addusers"
tags: ["Workspaces"]
---

# Add users to workspace

`POST /workspaces/addusers`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/workspaces/addusers`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Request body

- AddUserPayload
  - `workspace_guid` string, required
  - `users` UserInfo[], required: List of users to add to the workspace, up to 100 users
    - `user_guid` string
    - `email` string
    - `phone` string

## Response `200`

- AddUsersResponse
  - `added_users` AddedUser[]
    - `user_guid` string
    - `email` string
    - `phone` string
    - `success` boolean, required: Whether the user was added successfully
    - `message` string: Message about failure to add user
  - `failed_users` AddedUser[]
    - `user_guid` string
    - `email` string
    - `phone` string
    - `success` boolean, required: Whether the user was added successfully
    - `message` string: Message about failure to add user

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)
