Unsubscribe subscriber

POST/api/v1/subscribers/{id}/unsubscribe

Suppress a subscriber so they receive nothing further.

subscribers:writeEdit subscriber names and tags, and unsubscribe them.

Notes

Idempotent. Unsubscribing someone already unsubscribed succeeds and reports changed: false, keeping the ORIGINAL timestamp: the date a person opted out is a compliance record, not a field a retry should overwrite.

There is deliberately no resubscribe endpoint. Reversing an opt-out has to be the subscriber's own action.

Parameters

Name	In	Type	Default	Description
`id`	path	string		Subscriber id. Required.

Example

curl "https://resources.ashwanth.dev/api/v1/subscribers/YOUR_ID/unsubscribe" \
  -H "Authorization: Bearer $LEADMAGNET_API_KEY"

Try it

API key

Held in this page only, never saved or sent anywhere but this API. If you are signed in, you can leave it blank.

Parameters

id *

Request

POST /api/v1/subscribers/{id}/unsubscribe

Fill the required path parameter first.