One-click unsubscribe of a team notification address (RFC 8058)

POST

/api/v1/public/team-address/unsubscribe

curl --request POST \
  --url 'https://api.deploybase.eu/api/v1/api/v1/public/team-address/unsubscribe?team=example&token=example' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data List-Unsubscribe=example

The List-Unsubscribe-Post target of team mail sent to a team address that is not a member’s own. The team and token travel in the query string (a mailbox provider POSTs to the exact header URL); the form body must be List-Unsubscribe=One-Click. A token matching the address in force clears it and tells every owner; any other well-formed request also answers 200 and changes nothing, so repeated and stale clicks are harmless and nothing can be probed.

Parameters

Query Parameters

team

required

string

Team ID

token

required

string

Unsubscribe token

FormData Parameters

List-Unsubscribe

required

string

Must be One-Click

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "data": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Not a well-formed one-click request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}