Account invitations settings

Create tenant invite

This route creates a general invitation token. To create an invitation token for a specific tenant, send the tenant’s ID in the request’s body. To create an invitation token for a specific user of a tenant, you can add the user ID on the body params. If a user ID was provided, you can decide wether to send an email to the user or not via the shouldSendEmail param. In order to set up a specific expiration time, use the expiresInMinutes to declare when the invite is being invalidated. A vendor token is required for this route, it can be obtained from the vendor authentication route.

post/resources/tenants/invites/v1

Request

Request body

tenantIdstring required
userIdstring
expiresInMinutesnumber
shouldSendEmailboolean

Response

idstring required
vendorIdstring required
tenantIdstring required
userIdstring
tokenstring required
expiresstring date-time required
shouldSendEmailboolean required
namestring

Changes

No recorded changes to this operation across all 1 revision of this API.