Invite a user

POST /v1/users/invite

Invite someone to your store by email. Optionally give them a role or a set of individual permissions up front. The invitation email contains a link that expires at `expiresAt`.

Requires: user.invite

Request Body

Email address plus an optional role or permissions

InviteUserRequest

emailrequired

string

format: email

permissionsoptional

enum[]

roleIdoptional

string

Example Request

application/json

{
  "email": "user@example.com",
  "roleId": "string",
  "permissions": [
    "organization.owner"
  ]
}

Response Schema

InviteUserResponse

emailrequired

string

expiresAtrequired

string

format: date-time

invitationIdrequired

string

Example Response

201 OK — application/json

{
  "invitationId": "string",
  "email": "string",
  "expiresAt": "2025-01-15T12:00:00.000Z"
}