Create and send an invitation to join a merchant

orgIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID to invite the user to

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

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

1	curl -X POST https://api.koywe.com/api/v1/users/organizations/orgId/merchants/merchantId/invitations \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"email": "invited.user@example.com",
6	"roles": [
7	"MERCHANT_ADMIN",
8	"MERCHANT_VIEWER"
9	]
10	}'

1	{
2	"id": "inv_xxxxxxxxxxxxxx",
3	"email": "user@example.com",
4	"roles": [
5	"ADMIN_ROLE",
6	"VIEWER_ROLE"
7	],
8	"status": "PENDING",
9	"expiresAt": "2024-08-15T10:00:00Z",
10	"createdAt": "2024-08-08T10:00:00Z",
11	"invitedByUserId": "k3u_yyyyyyyyyyyyyy",
12	"merchantId": "mrc_zzzzzzzzzzzzzz",
13	"acceptedAt": "2024-08-09T10:00:00Z",
14	"acceptedByUserId": "k3u_xxxxxxxxxxxxxx"
15	}