Check unsubscribing worked

GET

/v1/addresses/{address}/unsubscribed

curl --request GET \
  --url https://api.proxymail.qa/v1/addresses/k7f2x9ab12cd%40mailclub.dev/unsubscribed \
  --header 'Authorization: Bearer <token>' \
  --header 'Proxy-Mail-QA-Test: sign-up%20%E2%80%BA%20sends%20one%20code'

For each sender the address unsubscribed from, the marketing emails that came after, by id and how long after, never their content. passed is false when any came; with a run, that fails it. Receipts, password resets and sign-in emails never count. In Labs: answers 403 until the key’s creator switches on Marketing and offer emails in Account settings → Labs.

Authorizations

• apiKey

Parameters

Path Parameters

address

required

string format: email

The test address, URL-encoded. A variant also works: capitals, or a +tag (k7f2x9ab12cd+o’brien@mailclub.dev). It acts on the plain address; waiting on a +tag variant, or listing its messages, only finds mail sent to that variant.

Example

k7f2x9ab12cd@mailclub.dev

Header Parameters

Proxy-Mail-QA-Run

string format: uuid

A run’s id (POST /v1/runs): adds what this call saw to the run. If it can’t be added (the run finished, or isn’t in this project), the call still works and the Proxy-Mail-QA-Run-Warning response header says why.

Proxy-Mail-QA-Test

string

<= 600 characters

With Proxy-Mail-QA-Run: the test this call belongs to, percent-encoded (encodeURIComponent), up to 200 characters once decoded. The run’s report shows it beside what the call saw.

Example

sign-up%20%E2%80%BA%20sends%20one%20code

Responses

200

Every unsubscribe and what came after

Media typeapplication/json

object

address

string

passed

No marketing email came after any unsubscribe.

boolean

watches

Array<object>

object

id

string format: uuid

sender

The sender’s domain.

string

service

string | null

unsubscribed_at

string format: date-time

via

string

Allowed values: app extension agent api

grace_seconds

Marketing within this long after unsubscribing doesn’t count.

integer

watching

False once the address subscribed again.

boolean

ended_at

string | null format: date-time

after_unsubscribe

Marketing emails from the sender that came after unsubscribing and its grace period (and before subscribing again).

Array<object>

object

email_id

string format: uuid

received_at

string format: date-time

after_seconds

integer

Example

{
  "watches": [
    {
      "via": "app"
    }
  ]
}

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}