Add unsubscribes

Request

Request body is expected to be a valid JSON encoded sting containing up to 1000 unsubscribe records or a single unsubscribe record as application/form-data

Security

basicAuth

Path

domain_namestringrequired

Domain to add the unsubscribe to

Headers

Content-Typestringrequired

Content-Type must be application/json if inserting using JSON, no header necessary for form-data insertion

Body

required

Array [

addressstringrequired

Email address for the original recipient

tagsArray of stringsrequired

Any tags present on the message the user clicked Unsubscribe on

created_atobject(github.com-mailgun-mime-RFC822Time)required

Timestamp for when the unsubscribe request was received in RFC822 format

]

curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/{domain_name}/unsubscribes' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "address": "alice@example.com",
      "tags": [
        "some tag"
      ],
      "createdat": "Thu, 11 Dec 2025 01:49:40 UTC"
    },
    {
      "address": "bob@example.com",
      "tags": [
        "*"
      ],
      "createdat": "Mon, 01 Jan 0001 00:00:00 UTC"
    },
    {
      "address": "carol@example.com",
      "tags": [],
      "createdat": "Mon, 01 Jan 0001 00:00:00 UTC"
    }
  ]'

Responses

A 200 response

Bodyapplication/json

messagestringrequired

Response message

Response

{
  "message": "4 addresses have been added to the unsubscribes table"
}