Groups

For more information on how to use these endpoints see: Group Subscribers

Group Member Management

Group Member Counts

See Bulk Group Actions for large group changes in a single request.

Create Group

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idnumberOptional
accountIdnumberOptional
namestringOptional
hiddennumberOptional
keywordstringOptional
welcomeMessagestringOptional
descriptionstringOptional
parentWebinarIdstringOptional
displayNamestring | nullableOptional
sortOrdernumber | nullableOptional
typestring · enumOptionalPossible values:
isTemporarybooleanOptional
createdAtone ofOptional
string · date-timeOptional
or
stringOptional
or
string | nullableOptional
Responses
chevron-right
200

Success

application/json
post
/groups

Get Group

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
Responses
chevron-right
200

Success

application/json
get
/groups/{groupId}

Update Group

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
Body
idnumberOptional
accountIdnumberOptional
namestringOptional
hiddennumberOptional
keywordstringOptional
welcomeMessagestringOptional
descriptionstringOptional
parentWebinarIdstringOptional
displayNamestring | nullableOptional
sortOrdernumber | nullableOptional
typestring · enumOptionalPossible values:
isTemporarybooleanOptional
createdAtone ofOptional
string · date-timeOptional
or
stringOptional
or
string | nullableOptional
Responses
chevron-right
200

Success

application/json
patch
/groups/{groupId}

Delete Group

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
Responses
chevron-right
200

Success

application/json
delete
/groups/{groupId}

List Groups

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
chevron-right
200

Success

application/json
get
/groups

Add Subscriber to Group

post

Required Fields: subscriberId

Note: Field addToDripCampaigns is true by default.

undefined

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
Body
subscriberIdnumberRequired
addToDripCampaignsbooleanOptional
Responses
chevron-right
200

Success

application/json
post
/groups/{groupId}/subscribers

Remove Subscriber from Group

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
subscriberIdstringRequired
Responses
chevron-right
200

Success

application/json
delete
/groups/{groupId}/subscribers/{subscriberId}

List All Groups and Member Count

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
chevron-right
200

Success

application/json
get
/groups/member-count/all

Get Adaptive Group Member Count

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
Responses
chevron-right
200

Success

application/json
get
/groups/{groupId}/member-count

Last updated

Was this helpful?