Create and send an invitation to join a merchant
Path parameters
orgId
Organization ID
merchantId
Merchant ID to invite the user to
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
email
Email address of the user to invite
roles
Array of role IDs or names to assign to the user for the merchant
Response
Invitation created and sent successfully.
id
Invitation ID
email
Email of the invited user
roles
Roles assigned in the invitation
status
Current status of the invitation
Allowed values:
expiresAt
Expiration date of the invitation token
createdAt
Creation date of the invitation
invitedByUserId
ID of the user who sent the invitation
merchantId
ID of the merchant for this invitation
acceptedAt
Date when the invitation was accepted
acceptedByUserId
ID of the user who accepted the invitation