unsubscribe

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-unsubscribe"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/29ec90f6-b9b1-4671-9092-7328abf82211/social-card.svg?v=3e7ae33eec8b" alt="unsubscribe" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/u/{*}

Unsubscribe confirmation page (does not change state)

Parameters

*stringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/u/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /u/{*}

POSThttps://hermetica.15.204.158.166.sslip.io/u/{*}

Unsubscribe (RFC 8058 one-click); idempotent

Parameters

*stringpathrequired

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/u/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

GEThttps://hermetica.15.204.158.166.sslip.io/p/{*}

Hosted preference page (channels, topics, frequency, unsubscribe all)

Parameters

*stringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/p/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

POSThttps://hermetica.15.204.158.166.sslip.io/p/{*}

Save preferences, or unsubscribe from everything

Parameters

*stringpathrequired

Request body

application/json
{}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/p/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

GEThttps://hermetica.15.204.158.166.sslip.io/p/ec/{*}

Confirm a new email address (page only; does not change state)

Parameters

*stringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/p/ec/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

POSThttps://hermetica.15.204.158.166.sslip.io/p/ec/{*}

Confirm a new email address; idempotent

Parameters

*stringpathrequired

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/p/ec/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

GEThttps://hermetica.15.204.158.166.sslip.io/p/t/{*}

Remove-a-tag confirmation page (does not change state)

Parameters

*stringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/p/t/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

POSThttps://hermetica.15.204.158.166.sslip.io/p/t/{*}

Remove the tag from the contact the link was sent to; idempotent

Parameters

*stringpathrequired

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/p/t/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

POSThttps://hermetica.15.204.158.166.sslip.io/u/resubscribe/{*}

Undo an unsubscribe from the same signed link: records a new opt-in in the consent ledger and lifts only that unsubscribe

Parameters

*stringpathrequired

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/u/resubscribe/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /u/{*}

5XX Default Response

Same as 4XX · GET /u/{*}

Updated