Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Unsubscribe

Remove contacts from an unsubscribe group

Removes one or more email addresses from an unsubscribe group and returns the number removed.

DELETE
/v1/unsubscribe-groups/{groupId}/members

Removes one or more email addresses from an unsubscribe group and returns the number removed.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

groupId*string
Match^unsub_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emails*array<string>
Items1 <= items

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/unsubscribe-groups/string/members" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "string"    ]  }'
{  "removed": 0}

Related documentation

Delete an unsubscribe group

Permanently deletes an unsubscribe group by its ID. Use this endpoint to delete an unsubscribe group through the Samva email API.

Update an unsubscribe group

Updates the name or description of an unsubscribe group. Use this endpoint to update an unsubscribe group through the Samva email API.