DELETE
/api/public/v1/newsletter-subscriptions/{subscriptionId}

Remove a newsletter subscription

Unsubscribe an email from a location’s newsletter.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

newsletter:subscriptions:write

Path Parameters

NameTypeRequiredDescription
subscriptionIdstringRequiredSubscription ID.
DELETEExample request
curl
curl -X DELETE "https://www.pxb.app/api/public/v1/newsletter-subscriptions/{subscriptionId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Newsletter subscription removed successfully.",
  "content": {}
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

No console screen

Subscribers unsubscribe from the link in a newsletter email. This endpoint is the only way to remove one by hand.