MerchantHQ API
POST /2024-09/users/merchant-memberships/invite
Default

Invite a new user to the specified merchant

application/json

Body Required

  • merchant_id string(uuid) Required

    The UUID of the resource.

  • email string(email) Required

    The email address of the user.

    Maximum length is 255.

  • role string Required

    The role of the user in the merchant

    Values are owner or manager.

Responses

  • 204

    Empty response with no content

  • 401 application/json

    The request requires user authentication or the user is not authorized to access this resource.

    Hide response attribute Show response attribute object
    • message string
  • 404 application/json

    The specified resource was not found

    Hide response attribute Show response attribute object
    • message string
POST /2024-09/users/merchant-memberships/invite 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/users/merchant-memberships/invite' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"merchant_id":"1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4","email":"john.doe@example.com","role":"owner"}'
Request examples 
{
  "merchant_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
  "email": "john.doe@example.com",
  "role": "owner"
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (404) 
{
  "message": "Not found"
}