v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Merchant Invitations

Create an invitation for a user to join a merchant

post/api/v1/merchants/{merchantId}/invitations

Path parameters

merchantIdstring uuid required

The merchantId parameter

Request body

emailstring email required

Invitee email address

rolestring required

Role to grant (e.g. admin, admin-read-only)

Example request

{
  "email": "invitee@example.com",
  "role": "admin"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "invitee@example.com",
    "scope_id": "550e8400-e29b-41d4-a716-446655440000",
    "role": "admin",
    "expires_at": "2026-02-12T00:00:00.000Z",
    "invited_by_user_id": "550e8400-e29b-41d4-a716-446655440000",
    "last_sent_at": "2026-02-05T12:00:00.000Z",
    "send_count": 1,
    "created_at": "2026-02-05T12:00:00.000Z",
    "invitation_link": "https://console.example.com/invitations/accept?token=abc123..."
  }
}