HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Churn record / Set reason

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Set or change the reason of an exit entry. Only the new reason is checked: it must apply to the entry's subject (users, partner invites, or partners and the partner's category). When the entry had no reason, the exit type set by the rule that ended the relationship is kept as ruleExitType. The token's admin and the time are recorded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the exit entry.

Body Params
churnReason
object
required

The new reason, with either reasonId or customReason and exitType. An empty object is rejected with a validation error. The reason must apply to the entry's subject. Custom reasons allow the chose_to_leave, forced and circumstances_changed exit types; partner invite entries also allow segment_switch.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json