Skip to main content
POST
/
api
/
public
/
teams
/
{teamId}
/
members
{
  "401 Unauthorized": {},
  "403 Forbidden": {},
  "400 Bad Request": {},
  "404 Not Found": {}
}

Add Team Members

Adds one or more members to a team by providing their full names and email addresses. Each new member is assigned the specified membership plan with the given start date. A maximum of 25 members can be added in a single request.

Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

Path Parameters

teamId
number
required
Numeric identifier of the team. Returned as Id from GET /api/public/teams/my.

Request Body

TariffId
number
required
ID of the membership plan to assign to the new members. Obtain available plans from the team’s default tariff or from the plans list.
FullNames
string[]
required
Array of full names for each new member. Must have the same number of entries as Emails.
Emails
string[]
required
Array of email addresses for each new member. Must have the same number of entries as FullNames. Each entry must be a valid email address.
StartDate
string
required
ISO 8601 date for when the new members’ plans should begin.

Response

Returns HTTP 200 OK with an empty body on success.

Examples

Add two members to a team

POST /api/public/teams/55/members
Authorization: Bearer {token}
Content-Type: application/json
{
  "TariffId": 301,
  "FullNames": ["Alice Johnson", "Carlos Rivera"],
  "Emails": ["alice@example.com", "carlos@example.com"],
  "StartDate": "2025-02-01T00:00:00.000Z"
}
Status: 200 OK
Body: (empty)

TypeScript Integration

import { endpoints } from '@/api/endpoints'

await httpClient.post(endpoints.teams.addMembers(teamId), {
  TariffId: 301,
  FullNames: ['Alice Johnson'],
  Emails: ['alice@example.com'],
  StartDate: new Date().toISOString(),
})

Usage in Portal

ContextSource file
Add member modal (/team/members/{teamId})src/views/user/team/members/components/TeamMemberAddModal.tsx

Error Responses

401 Unauthorized
error
The customer is not authenticated or the session has expired.
403 Forbidden
error
The customer is not an administrator of the specified team.
400 Bad Request
error
Validation error — for example, mismatched array lengths for FullNames and Emails, more than 25 members, or invalid email format.
404 Not Found
error
Team with the specified ID does not exist.
MethodEndpointDescription
DELETE/api/public/teams/{teamId}/members/{coworkerId}Remove a member from a team
GET/api/public/teams/myList the customer’s teams
GET/api/public/teams/{teamId}/profileFull team profile
PUT/api/public/teams/{teamId}/permissions/{memberId}Update member permissions