Comment on page

Team Management APIs

For a complete list of team management API endpoints, see OpenAPI Specification​
Group Management
Update Group Membership
To update the members of a Group, use the memberships endpoint:
PUT /api/groups/:groupId/memberships/
The members list you provide will replace the current membership list. Existing members that are not in the payload will be removed from the group
To include an email, the user must be either: 1) already a member of your team, or 2) have an email domain that has been verified for your team. To verify an email domain for your team, contact [email protected]​
​
Example payload:
[
 {"email": "[email protected]"}, 
 {"email": "[email protected]"} 
]
Campaign Management
Retrieve Campaign Membership
To retrieve membership information for a given campaign, use the following endpoint:
GET /api/organizations/:organizationId/campaigns/:campaignId/members/
Update Campaign Membership
To update the name or members of a Campaign, use the campaign resource endpoint:
GET /api/organizations/:organizationId/campaigns/: list campaigns in your organization
PUT /api/organizations/:organizationId/campaigns/:campaignId/
The members list you provide will replace the current membership list. Existing members that are not in the payload will be removed from the campaign
To include an email, the user must be either: 1) already a member of your team, or 2) have an email domain that’s been verified for your team. To verify an email domain for your team, contact [email protected]​
The users list supports a data property where you can provide custom master data about the users for reporting, e.g., Location, Organization Unit, etc.
Example payload:
{
 "name": "Campaign Name",
 "users": [
 {
 "email": "[email protected]",
 "data": {
 "Location": "New York, NY"
 }
 }
 ]
}

Making an API Request

Package Management APIs

Last modified 28d ago