Unsubscribe

Unsubscribe list stores email addresses of recipients who unsubscribed from your mailings by clicking a Mailgun generated unsubscribe link.

Operations

Import unsubscribe list

Request

Import a CSV file containing a list of addresses to add to the unsubscribe list. The CSV file must be 25MB or under and can contain the following column headers: address, tags, created_at. address is a valid email address (required). tags is tag to unsubscribe from, use * to unsubscribe an address from all domain's correspondence (optional, default: *). created_at is timestamp of unsubscribe event in RFC2822 format (optional, default: current time)

Security

basicAuth

Path

domain_namestringrequired

Domain to update unsubscribes for

Headers

Content-Typestringrequired

Content-Type must be multipart/form-data

Bodymultipart/form-datarequired

filestringrequired

CSV file

curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/{domain_name}/unsubscribes/import' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

A 202 response

Bodyapplication/json

messagestringrequired

Response message

Response

{
  "message": "file uploaded successfully for processing. standby..."
}