---
title: "Invite users to teams in bulk"
method: POST
path: "/v2/teams/bulk/invite-user"
tags: ["BulkTeamOperations"]
---

# Invite users to teams in bulk

`POST /v2/teams/bulk/invite-user`

This endpoint sends invitations to multiple users to join specified teams in a single request. Each invitation includes the team ID, roles to assign, and the email address of the user to be invited. Optionally specify a custom invitation URL and language code for the email template.

## Request body

- V2BulkInviteUsersRequest
  - `inviteUsers` V2InviteTeam[], required — A list of team invitations to send. Each invitation specifies the team, roles, and user email.
    - `managerTeamId` string — The unique identifier of the retailer team. The retailer team handles access management and can send invitations to users, including suppliers.
    - `roleIds` Authv2RoleTypes[], required — The team permissions. Users can be assigned either retailer or supplier permissions: - Retailer full: Provides users full access, allowing them to modify administration settings, campaigns, reviews, team manager roles, and team settings. - Retailer report view: Provides users with read only access to dashboards, campaigns, and reporting data. - Supplier full: Provides users full access, allowing them to modify administration settings, campaigns, and team settings. - Supplier report view: Provides users with read only access to dashboards, campaigns, and reporting data.
    - `teamId` string, required — A unique identifier for the team linked to the user who will receive the invitation.
    - `emailToInvite` string, required — The email address of the user who will be invited to join the team.
    - `inviteUrl` string — The base invitation url emailed to the user to respond to their invitation and continue the onboarding process.
    - `languageCode` 'EN_US' | 'CS_CZ' | 'FR_FR' | 'HU_HU' | 'IT_IT' | 'JA_JP' | 'KO_KR' | 'PT_BR' | 'SK_SK' | 'ES_ES' — Language code as per ISO 639-1 format.

## Response `200`

The bulk invite operation completed. Check the response for individual invitation results.

- V2BulkInviteUsersResponse
  - `bulkId` string — Unique identifier for the bulk operation.
  - `status` 'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
  - `message` string — Success message for the operation.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)