Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Configure cancel survey

Creates or updates a cancel survey for a subscription.

Either reasonId or reasonName can be provided, but reasonId takes precedence.

post/subscriptions/cancelSurvey/response

Request body

subscriptionstring required

Unique ID of the subscription for which the survey is submitted.

Example request

{
  "subscription": "aBCDE12fGH3iJkL4mNOpqr",
  "cancelSurvey": {
    "reasonId": "7",
    "reasonName": "other",
    "feedbackText": "Optional feedback text",
    "lang": "en"
  }
}

Response

OK

idstring

Unique identifier for the cancel survey record.

reasonIdstring

The cancel reason ID that was saved.

namestring

Predefined name for the cancel reason.

displayNamestring

Label shown to the user in the cancel survey.

descriptionstring

Long-form explanation of the cancel reason.

feedbackTextstring

User-submitted feedback captured during the cancellation.

langstring

Language code used when the cancel survey was submitted.

Example response

{
  "id": "2cDfgHIjKLmNOPqRs_tUV",
  "reasonId": "7",
  "name": "other",
  "displayName": "Other",
  "description": "Other",
  "feedbackText": "Optional feedback text",
  "lang": "en"
}