Partner Invite / Create

post deprecated

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

This endpoint is deprecated. Use resources/partner-invites/v2.0 instead.

Create new 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."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Invite created successfully

401Access token is missing or invalid

403You do not have permission to perform the action. When the organisation of the admin behind the token has view-only access, every write is refused with the message "Your access is view-only."

409The partner the request refers to is being offboarded or is disabled, so it doesn't accept new business. The message states what is refused and that the partner must be enabled first. Nothing is created or changed.

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*