Skip to main content
POST
Create User
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Create a new user account for the authenticated vendor. The vendorId is automatically derived from the vendor token, and the user type is always set to vendor. Optionally send an invitation email to the new user.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

Use Cases

  • Invite team members to the vendor portal
  • Automate account provisioning for new vendor staff

Request Body

string
required
Email address for the new user. Must be a valid email format.
string
required
Password for the new user (minimum 6 characters).
string
Vendor name label for the user.
boolean
default:"false"
Whether the account is immediately active.
boolean
Enable email notifications for the user.
boolean
default:"false"
Send an invitation email to the new user.
object
User profile information.
object
Permission configuration object for granular access control.

Response

201

Error Responses

409

Example