Create and send an invitation to join a merchant

Path parameters

orgIdstringRequired
Organization ID
merchantIdstringRequired
Merchant ID to invite the user to

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
emailstringRequired
Email address of the user to invite
roleslist of stringsRequired
Array of role IDs or names to assign to the user for the merchant

Response

Invitation created and sent successfully.
idstring
Invitation ID
emailstring
Email of the invited user
roleslist of strings
Roles assigned in the invitation
statusenum
Current status of the invitation
Allowed values:
expiresAtdatetime
Expiration date of the invitation token
createdAtdatetime
Creation date of the invitation
invitedByUserIdstring
ID of the user who sent the invitation
merchantIdstring
ID of the merchant for this invitation
acceptedAtdatetime or null
Date when the invitation was accepted
acceptedByUserIdstring or null
ID of the user who accepted the invitation

Errors