v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
team

Invite a user to the team

Sends an invitation to a user to join a specified team. It requires parameters such as the team's unique identifier and the email address of the user to be invited. The retailer team, identified by a unique ID, manages access and can also invite suppliers.

post/v2/invite_teams

Request body

Example request

{
  "inviteTeam": {
    "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 invite user team

invitationTokenstring

The invitation_token of the team.