GroupService

Manages recipient groups used for campaign audience targeting. Groups are named collections of users that can span teams and departments.

Methods

Method	Description
CreateGroup	Create a new group
GetGroup	Get a group by ID
ListGroups	List groups for the organization
UpdateGroup	Update a group’s name or description
DeleteGroup	Delete a group
AddGroupMembers	Add members to a group
RemoveGroupMembers	Remove members from a group
ListGroupMembers	List members of a group
GetUserGroupMemberships	Get all groups a user belongs to

CreateGroup

Authorization: Requires PERMISSION_GROUPS_WRITE (own groups) or PERMISSION_GROUPS_ALL_WRITE permission

Request: CreateGroupRequest

Field	Type	Description
name	string	Group name. Max 200 characters.
description	string	Group description. Max 1000 characters.

Response: CreateGroupResponse

Field	Type	Description
group	Group	The created group.

GetGroup

Authorization: Requires PERMISSION_GROUPS_ALL_READ or PERMISSION_GROUPS_ALL_WRITE permission

Request: GetGroupRequest

Field	Type	Description
id	string	Group ID.

Response: GetGroupResponse

Field	Type	Description
group	Group	The group.

ListGroups

Authorization: Requires PERMISSION_GROUPS_ALL_READ or PERMISSION_GROUPS_ALL_WRITE permission

Request: ListGroupsRequest

Field	Type	Description
pagination	Pagination	Pagination parameters.

Response: ListGroupsResponse

Field	Type	Description
groups	Group[]	List of groups.
pagination	PaginationMeta	Pagination metadata.

UpdateGroup

Authorization: Requires PERMISSION_GROUPS_WRITE (own groups) or PERMISSION_GROUPS_ALL_WRITE permission

Request: UpdateGroupRequest

Field	Type	Description
id	string	Group ID.
name	string	Updated name.
description	string	Updated description.

Response: UpdateGroupResponse

Field	Type	Description
group	Group	The updated group.

DeleteGroup

Authorization: Requires PERMISSION_GROUPS_WRITE (own groups) or PERMISSION_GROUPS_ALL_WRITE permission

Request: DeleteGroupRequest

Field	Type	Description
id	string	Group ID to delete.

Response: DeleteGroupResponse

Empty response on success.

AddGroupMembers

Authorization: Requires PERMISSION_GROUPS_WRITE (own groups) or PERMISSION_GROUPS_ALL_WRITE permission

Request: AddGroupMembersRequest

Field	Type	Description
group_id	string	Group ID.
user_ids	string[]	User IDs to add. Max 1000 per request.

Response: AddGroupMembersResponse

Field	Type	Description
added_count	int32	Number of members added.

RemoveGroupMembers

Authorization: Requires PERMISSION_GROUPS_WRITE (own groups) or PERMISSION_GROUPS_ALL_WRITE permission

Request: RemoveGroupMembersRequest

Field	Type	Description
group_id	string	Group ID.
user_ids	string[]	User IDs to remove.

Response: RemoveGroupMembersResponse

Field	Type	Description
removed_count	int32	Number of members removed.

ListGroupMembers

Authorization: Requires PERMISSION_GROUPS_ALL_READ or PERMISSION_GROUPS_ALL_WRITE permission

Request: ListGroupMembersRequest

Field	Type	Description
group_id	string	Group ID.
pagination	Pagination	Pagination parameters.

Response: ListGroupMembersResponse

Field	Type	Description
users	User[]	List of group members.
pagination	PaginationMeta	Pagination metadata.

GetUserGroupMemberships

Authorization: Authenticated user (own memberships) or PERMISSION_GROUPS_ALL_READ permission

Request: GetUserGroupMembershipsRequest

Field	Type	Description
user_id	string	User ID.

Response: GetUserGroupMembershipsResponse

Field	Type	Description
memberships	UserGroupMembership[]	Groups the user belongs to.

Group Message

Field	Type	Description
id	string	Unique identifier.
name	string	Group name.
description	string	Group description.
member_count	int32	Number of members.
created_at	Timestamp	Creation timestamp.
updated_at	Timestamp	Last update timestamp.