HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner invite / Create

Create a partner invite.

A partner that is being offboarded or is disabled does not accept new invites: a valid request for such a partner is rejected with 409: "This partner is being offboarded or is disabled. Enable it to invite drivers."

Reimbursement coverage of specific RFIDs and vehicles (allow) can be declared here only when the invited email address resolves to an existing user of the partner's operator, since the listed entities are validated against that user — listed RFIDs must belong to the invite's partner and must either belong to that user or have no owner, and listed vehicles must belong to the invite's partner. When no such user exists yet, coverage of specific entities is rejected with a validation error; create the invite without it and declare the covered set via the update endpoint once the invite is accepted.

Declaring coverage of specific entities 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. This happens when the invite is accepted if it is still pending, or as part of the write itself when the invite is already accepted — including on the update endpoint.

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…
Body Params

Partner invite create payload.

integer
required
boolean
Defaults to true
string

Required if sendViaEmail is true or omitted. Optional when sendViaEmail is false; when provided, the invite is linked to the matching user without dispatching an email.

string
enum

The language of the e-mail sent to the invitee. If none selected, the default end-users language will be used.

integer

The access policy ID to assign. Must reference a policy accessible to the partner. Omit the field when no policy should be assigned.

integer

The corporate billing policy ID to assign. Must reference an active policy that belongs to the partner.

reimbursement
object

Home-charging reimbursement settings for the invite. 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. Omit the field or send an empty array when the invite has no user groups.

userGroupIds
date

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.

date

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.

churnReason
object

Churn reason recorded when the invite expires on expiresOn. Requires expiresOn. Send an empty object or omit it to record no reason. 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

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