API reference
Subscriptions
/subjects
A subscription is what events are about. Customers are subscribed to subscriptions through /links. In the Subscription business pack a subscription is, for example, “Raven Tier 2” with reference SUB-2026-001.
GET/subjectsList · ?q ?external_refPOST/subjectsCreateGET/subjects/{subject_id}ReadPATCH/subjects/{subject_id}Update · attributes replaced wholePOST/subjects/{subject_id}/deactivateDeactivate · no deleteshown →
POSTDeactivate a subscription
Requires subjects:write. There is no delete. An inactive subscription keeps its history and drops out of every segment and every rule. It is reversible.
Path parameters
subject_iduuid · required
The subscription id.
Body parameters
reasonstring · optional · max 500
Kept on the record.
Returns
200 with the subscription, status: inactive.
Response body
One subscription: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
tenant_iduuidThe instance.
external_refstring | nullYour own id, as you sent it.
display_namestring
attributesobjectShaped by the Subscription business pack's subject_schema.Varies by pack
statusactive | inactive
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.