Invite a workspace user

Creates a workspace user record or promotes an existing imported profile, then sends an invitation email.

POST/api/users

Creates a workspace user record or promotes an existing imported profile, then sends an invitation email.

Request Body

application/json

Request payload for Invite a workspace user.

TypeScript Definitions

Use the request body type in TypeScript.

workspaceUserId?|

Existing workspace user profile to promote into an invitation.

name*string

Display name for the invited workspace user.

Length1 <= length

email*string

Email address used for the invitation.

Example"jane@example.com"

description?|

Optional description shown in the workspace user list.

defaultRole*string

Initial workspace role assigned to the user.

Example"default"

Value in

"default"
"admin"
"collaborator"
"sales_executive"
"view_only"
"price_manager"
"product_media_manager"

Response Body

`application/json`

curl -X POST "https://example.com/api/users" \  -H "Content-Type: application/json" \  -d '{    "name": "Jane Doe",    "email": "jane@example.com",    "defaultRole": "default"  }'

{  "success": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Invite a workspace user

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`