Manages organizational teams (departments, divisions). Teams are structural units within an organization and can be used for campaign audience targeting.
| Method |
Description |
CreateTeam |
Create a new team |
GetTeam |
Get a team by ID |
ListTeams |
List teams for the organization |
UpdateTeam |
Update a team |
DeleteTeam |
Delete a team |
AddTeamMembers |
Add members to a team |
RemoveTeamMembers |
Remove members from a team |
ListTeamMembers |
List members of a team |
Authorization: Requires PERMISSION_TEAMS_WRITE (own teams) or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
name |
string |
Team name. Max 200 characters. |
description |
string |
Team description. Max 1000 characters. |
| Field |
Type |
Description |
team |
Team |
The created team. |
Authorization: Requires PERMISSION_TEAMS_ALL_READ or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
id |
string |
Team ID. |
| Field |
Type |
Description |
team |
Team |
The team. |
Authorization: Requires PERMISSION_TEAMS_ALL_READ or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
pagination |
Pagination |
Pagination parameters. |
| Field |
Type |
Description |
teams |
Team[] |
List of teams. |
pagination |
PaginationMeta |
Pagination metadata. |
Authorization: Requires PERMISSION_TEAMS_WRITE (own teams) or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
id |
string |
Team ID. |
name |
string |
Updated name. |
description |
string |
Updated description. |
| Field |
Type |
Description |
team |
Team |
The updated team. |
Authorization: Requires PERMISSION_TEAMS_WRITE (own teams) or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
id |
string |
Team ID to delete. |
Empty response on success.
Authorization: Requires PERMISSION_TEAMS_WRITE (own teams) or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
team_id |
string |
Team ID. |
user_ids |
string[] |
User IDs to add. Max 1000 per request. |
| Field |
Type |
Description |
added_count |
int32 |
Number of members added. |
Authorization: Requires PERMISSION_TEAMS_WRITE (own teams) or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
team_id |
string |
Team ID. |
user_ids |
string[] |
User IDs to remove. |
| Field |
Type |
Description |
removed_count |
int32 |
Number of members removed. |
Authorization: Requires PERMISSION_TEAMS_ALL_READ or PERMISSION_TEAMS_ALL_WRITE permission
| Field |
Type |
Description |
team_id |
string |
Team ID. |
pagination |
Pagination |
Pagination parameters. |
| Field |
Type |
Description |
users |
User[] |
List of team members. |
pagination |
PaginationMeta |
Pagination metadata. |
| Field |
Type |
Description |
id |
string |
Unique identifier. |
name |
string |
Team name. |
description |
string |
Team description. |
member_count |
int32 |
Number of members. |
created_at |
Timestamp |
Creation timestamp. |
updated_at |
Timestamp |
Last update timestamp. |