API docs by Redocly

Mail Unsubscribe API (1.0.0)

Download OpenAPI specification:Download

API for managing email unsubscription

Mail Unsubscribe

Email unsubscription management operations

Get all unsubscribed emails

Retrieve a list of all unsubscribed email addresses with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

email
string

Filter by email address

company_namespace
Array of strings

Company namespace for filtering

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Add email to unsubscribe list

Add an email address to the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string <email>

Email address to unsubscribe

reason
string

Reason for unsubscribing

unsubscribe_types
Array of strings
Default: ["all"]

Types of emails to unsubscribe from

company_namespace
Array of strings

Company namespace

user_agent
string

User agent of the request

ip_address
string

IP address of the request

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "reason": "User requested unsubscribe",
  • "unsubscribe_types": [
    ],
  • "company_namespace": [
    ],
  • "user_agent": "string",
  • "ip_address": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get unsubscribe record by ID

Retrieve a specific unsubscribe record by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Unsubscribe record ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Remove email from unsubscribe list

Remove an email address from the unsubscribe list (re-subscribe)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Unsubscribe record ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk remove emails from unsubscribe list

Remove multiple email addresses from the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of unsubscribe record IDs to remove

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Check if email is unsubscribed

Check if an email address is in the unsubscribe list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string <email>

Email address to check

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}