TeamService
Esta página aún no está disponible en tu idioma.
Manages organizational teams (departments, divisions). Teams are structural units within an organization and can be used for campaign audience targeting.
Methods
Section titled “Methods”| 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 |
CreateTeam
Section titled “CreateTeam”Authorization: Requires MANAGE_TEAMS permission
Request: CreateTeamRequest
Section titled “Request: CreateTeamRequest”| Field | Type | Description |
|---|---|---|
name | string | Team name. Max 200 characters. |
description | string | Team description. Max 1000 characters. |
Response: CreateTeamResponse
Section titled “Response: CreateTeamResponse”| Field | Type | Description |
|---|---|---|
team | Team | The created team. |
GetTeam
Section titled “GetTeam”Authorization: Requires VIEW_TEAMS permission
Request: GetTeamRequest
Section titled “Request: GetTeamRequest”| Field | Type | Description |
|---|---|---|
id | string | Team ID. |
Response: GetTeamResponse
Section titled “Response: GetTeamResponse”| Field | Type | Description |
|---|---|---|
team | Team | The team. |
ListTeams
Section titled “ListTeams”Authorization: Requires VIEW_TEAMS permission
Request: ListTeamsRequest
Section titled “Request: ListTeamsRequest”| Field | Type | Description |
|---|---|---|
pagination | Pagination | Pagination parameters. |
Response: ListTeamsResponse
Section titled “Response: ListTeamsResponse”| Field | Type | Description |
|---|---|---|
teams | Team[] | List of teams. |
pagination | PaginationMeta | Pagination metadata. |
UpdateTeam
Section titled “UpdateTeam”Authorization: Requires MANAGE_TEAMS permission
Request: UpdateTeamRequest
Section titled “Request: UpdateTeamRequest”| Field | Type | Description |
|---|---|---|
id | string | Team ID. |
name | string | Updated name. |
description | string | Updated description. |
Response: UpdateTeamResponse
Section titled “Response: UpdateTeamResponse”| Field | Type | Description |
|---|---|---|
team | Team | The updated team. |
DeleteTeam
Section titled “DeleteTeam”Authorization: Requires MANAGE_TEAMS permission
Request: DeleteTeamRequest
Section titled “Request: DeleteTeamRequest”| Field | Type | Description |
|---|---|---|
id | string | Team ID to delete. |
Response: DeleteTeamResponse
Section titled “Response: DeleteTeamResponse”Empty response on success.
AddTeamMembers
Section titled “AddTeamMembers”Authorization: Requires MANAGE_TEAMS permission
Request: AddTeamMembersRequest
Section titled “Request: AddTeamMembersRequest”| Field | Type | Description |
|---|---|---|
team_id | string | Team ID. |
user_ids | string[] | User IDs to add. Max 1000 per request. |
Response: AddTeamMembersResponse
Section titled “Response: AddTeamMembersResponse”| Field | Type | Description |
|---|---|---|
added_count | int32 | Number of members added. |
RemoveTeamMembers
Section titled “RemoveTeamMembers”Authorization: Requires MANAGE_TEAMS permission
Request: RemoveTeamMembersRequest
Section titled “Request: RemoveTeamMembersRequest”| Field | Type | Description |
|---|---|---|
team_id | string | Team ID. |
user_ids | string[] | User IDs to remove. |
Response: RemoveTeamMembersResponse
Section titled “Response: RemoveTeamMembersResponse”| Field | Type | Description |
|---|---|---|
removed_count | int32 | Number of members removed. |
ListTeamMembers
Section titled “ListTeamMembers”Authorization: Requires VIEW_TEAMS permission
Request: ListTeamMembersRequest
Section titled “Request: ListTeamMembersRequest”| Field | Type | Description |
|---|---|---|
team_id | string | Team ID. |
pagination | Pagination | Pagination parameters. |
Response: ListTeamMembersResponse
Section titled “Response: ListTeamMembersResponse”| Field | Type | Description |
|---|---|---|
users | User[] | List of team members. |
pagination | PaginationMeta | Pagination metadata. |
Team Message
Section titled “Team Message”| 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. |