Invite a workspace user

POST/api/unstable/users

Creates a workspace user record and sends an invitation email.

Request Body

application/json

name*string

Display name for the invited workspace user.

Length1 <= length

Example"Jane Doe"

email*string

Email address used for the invitation.

Example"jane@example.com"

description?string

Optional description shown in the workspace user list.

Example"Sales manager"

defaultRole*string

Initial workspace role assigned to the user.

Value in"admin" | "collaborator" | "price_manager" | "product_media_manager"

Example"collaborator"

[key: string]?never

Response Body

`application/json`

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

{
  "success": true
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Invite a workspace user

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`