HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner / Disable

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.

Disable the partner now, with the same rules as the Disable action in the admin panel. The status becomes disabled and the partner's contracts end today. Its drivers' partner invites expire in the background after the response. The partner's administrators lose access now, or keep view-only access for one month when keepViewOnlyAccess is true.

When disableChargePoints is true, the partner's charge points are also set to Disabled. This happens in the background after the response. Enabling the partner enables them again.

On an enabled partner churnReason is required. On an offboarding partner the churn reason given when offboarding started is kept, and sending churnReason returns 422.

Available only while the partner is enabled or offboarding; in any other status the action returns 409 and nothing is changed.

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
churnReason
object

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

boolean
Defaults to false

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

boolean
Defaults to false

When true, the partner's charge points are also set to Disabled.

Responses

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