Unenrol (Leave) Programme

This page allows the customer to leave the VPP programme. The customer can review the implications of leaving, such as loss of benefits or incentives, and confirm their decision to exit the programme.

Preview
Code

{
    "connect_token": "cot_6587fa4362341be5b524de3b",
    "route": "vpp_unenrol",
    "timezone": "America/Denver",
    "currency_code": "USD",
    "live_mode": true,
    "actions": [
        "CONFIRM_UNENROL",  
        "KEEP_PARTICIPATION",
        "BACK",
        "CLOSE"
    ],
     "programme": {
        "provider_id": "prv_8587fa49c7e5297ccc6c57e5",
        "provider_display_name": "Leap",
        "programme_id": "vpr_6a1f8e375db9de605baadd46",
        "programme_display_name": "Community Powershare",
        "learn_more_url": "https://leap.com/programmes/community-powershare",
      },
    "earned_to_date": 402.27,
    "unsubscribe_window_days": 30
}

Actions

Following actions are supported when responding to Connect on this route:

Action	Result
`CONFIRM_UNENROL`	Initiates leaving the programme
`KEEP_PARTICIPATION`	Stay in programme
`BACK`	Returns previous page. If unavailable, returns `callback_url`.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Errors

When you POST your response to Connect, the following validation errors may be returned:

Error Code	Error Description
`email_invalid`	Email is invalid.
`phone_invalid`	Phone number is invalid.
`data_json_invalid`	Data does not conform to the JSON schema.

​Actions

​Errors

Actions

Errors