HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner / Start offboarding

Experimental endpoint — not yet a stable contract. This action 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.

Start offboarding the partner, with the same rules as the Start offboarding action in the admin panel. The status becomes offboarding and offboardingEndsOn is set to endsOn. The partner's active contracts are offboarded with the same end date; a contract that starts after endsOn is not offboarded but ended right away, and its charge points are disabled. The partner's charge points are set to Disabled and its drivers' partner invites expire; both happen in the background after the response. Monthly platform fees continue until the end date. The partner's administrators keep view-only access until the end date, or for one month after it when keepViewOnlyAccess is true. After the end date the status becomes disabled.

On an offboarding partner the action changes the end date and the churn reason of the offboarding already in progress.

Available only while the partner is enabled or offboarding; in any other status the action returns 409 and nothing is changed. An end date before today in the operator's timezone returns 422 with "The end date can't be in the past.".

Only operator and global tokens may run this action, when their administrator may update the partner. Partner and sub-operator tokens get 403.

Required permission: Partners.update

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

The last day of the partnership, inclusive, ending at midnight in the operator's timezone. Must be today or later.

churnReason
object
required

Why the partner leaves. Send either reasonId or customReason with exitType.

boolean
Defaults to true

When true, the partner's administrators keep view-only access for one month after the end date. When false, their access ends with the end date.

Responses

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