v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
BulkTeamOperations

Invite users to teams in bulk

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.

post/v2/teams/bulk/invite-user

Request body

Example request

{
  "inviteUsers": [
    {
      "managerTeamId": "manager-team-123",
      "roleIds": [
        "ROLE_TYPES_SUPPLIER_FULL",
        "ROLE_TYPES_RETAILER_REPORT_VIEW"
      ],
      "teamId": "team-456",
      "emailToInvite": "invitee@example.com",
      "inviteUrl": "https://campaign.citrusad.com/user/invite"
    }
  ]
}

Response

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

bulkIdstring

Unique identifier for the bulk operation.

status'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
messagestring

Success message for the operation.