Link Existing User to Merchant

Grants an existing user access to one or more merchants. This creates membership records (pivot rows) without creating a new user or modifying the user's identity fields. Each merchant in the request is authorized individually — the caller must be an active admin of every merchant being granted, or a system_admin. If any merchant is unauthorized, the entire request is rejected with no partial application.

Path Params
string
required

The ID of the existing user to grant merchant access to.

Body Params
merchants
array of objects
required
length between 1 and 25

List of merchants to grant access to. Maximum 25 per request.

merchants*
string
required

The ID of the merchant to grant access to. Must be unique within the request.

string
enum
required

The team role to assign for this merchant.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json