Subscribers
Unsubscribe subscriber
Unsubscribes the subscriber from all future emails, moving them to the cancelled state. Returns 204 No Content on success. The subscriber record, history, and tags are retained — they are not deleted from the account.
Note: this is the API equivalent of the subscriber clicking unsubscribe. Treat it as consent-revoking and effectively permanent — only re-subscribe someone with their explicit permission.
post/v4/subscribers/{id}/unsubscribe
Request
- Base URLhttps://api.kit.com
- URLhttps://api.kit.com/v4/subscribers/{id}/unsubscribe
- Auth
- API key in header X-Kit-Api-Key
- or OAuth 2Authorization code: https://api.kit.com/v4/oauth/authorizeToken URL: https://api.kit.com/v4/oauth/token
Path parameters
idinteger required
Request body
object required
Response
Unsubscribes the subscriber
Changes
No recorded changes to this operation across all 2 revisions of this API.