HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Partner invite / Update

patch
https://{tenantUrl}/public-api/resources/partner-invites/v2.0/

Update a partner invite.

An invite that expired because its partner was offboarded or disabled cannot be restored through expiresOn until the partner is enabled again: a valid request that sets expiresOn to today or later is rejected with 409: "This invite expired because the partner was offboarded or disabled. Enable the partner to restore it."

Moving the invite to another partner (partnerId) that is being offboarded or is disabled is rejected with 409: "This partner is being offboarded or is disabled. Enable it to invite drivers." An invite that already belongs to such a partner can still be updated as long as its partner is not changed.

Declaring reimbursement coverage of specific RFIDs and vehicles (allow) also assigns them to the invited user: listed RFIDs with no owner get that user as their owner, and that user is added to the users of listed vehicles they are not yet a user of. When the invite is still pending this happens once it is accepted; when the invite is already accepted it happens as part of this request. Listed RFIDs must belong to the invite's partner and must either belong to the invited user or have no owner, and listed vehicles must belong to the invite's partner.

Experimental endpoint — not yet a stable contract. partner-invites/v2.0 ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v2.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.

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

Partner invite update payload.

integer
integer | null

The access policy ID to assign. Must reference a policy accessible to the partner. Send null to clear any assigned policy; omit the field to leave the current value unchanged.

integer | null

The corporate billing policy ID to assign. Must reference an active policy that belongs to the partner. Send null to clear any assigned policy; omit the field to leave the current value unchanged.

reimbursement
object

Home-charging reimbursement settings for the invite. Omit the object to leave every reimbursement setting unchanged. Ignored when home-charging reimbursement is disabled.

userGroupIds
array of integers, unique

IDs of the user groups the user is added to when the invite's benefits start (on acceptance, or at the start of startsOn if that is later), and again when an expired invite is restored. Each must reference a user group of the partner. Changing the list does not change the user groups the user already belongs to. The whole list is replaced; send an empty array to clear it; omit the field to leave the current value unchanged. The user groups of an accepted invite can't be changed. When partnerId stays the same, a different list returns 409, also a list that would fail the partner check, because that check does not run for an accepted invite. Sending the stored list again, in any order, is accepted and leaves the list unchanged. When partnerId changes, the stored list must be valid for the new partner unless it is empty or holds only deleted user groups; otherwise send userGroupIds with user groups of the new partner, or an empty array.

userGroupIds
date | null

Date from which the user gets the invite's benefits, in the timezone of the partner's operator. The benefits start at the beginning of this date. Send null to clear the date; omit the field to leave the current value unchanged.

date | null

Date on which the invite expires, in the timezone of the partner's operator. The invite expires when this date ends. Can't be in the past and can't be before startsOn. Sending a date of today or later restores an expired invite, including the date it already shows. Send null to clear the date; omit the field to leave the current value unchanged.

churnReason
object

Churn reason recorded when the invite expires on its expiration date. Requires an expiration date of today or later, sent in expiresOn or already set on an invite that hasn't expired. Replaces the stored reason; send an empty object to remove it, or omit the field to keep it. Clearing expiresOn also removes it. The reason must apply to partner invites. Custom reasons allow the chose_to_leave, forced, circumstances_changed and segment_switch exit types. Not returned in the response.

Responses

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?