Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Unsubscribe

List unsubscribe groups

Returns every unsubscribe group in the organization, the default group first, then by name. An organization holds at most 200, so the list is never paged.

GET
/v1/unsubscribe-groups

Returns every unsubscribe group in the organization, the default group first, then by name. An organization holds at most 200, so the list is never paged.

Authorization

apiKey
x-api-key<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/unsubscribe-groups"
{  "items": [    {      "id": "string",      "organizationId": "string",      "name": "string",      "description": "string",      "isDefault": true,      "memberCount": 0,      "createdAt": "string",      "updatedAt": "string"    }  ]}

Related documentation

Create an unsubscribe group

Creates a new unsubscribe group and returns it with a 201 Created status. An organization holds at most 200 groups.

List unsubscribe group members

Returns the email addresses in an unsubscribe group, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page.