Skip to main content
POST
/
v2
/
users
Invite user to the platform
curl --request POST \
  --url https://api.pelanor.io/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invites": [
    {
      "email": "<string>",
      "name": "<string>",
      "assignments": [
        {
          "workspaceId": "<string>",
          "role": "ADMIN"
        }
      ]
    }
  ]
}
'
{}
Invites a new user to Pelanor - once the request succeeds, an email invite will be sent to the specified address.
When being invited, users must be associated to at least one workspace. Use the List Workspaces endpoint to get the relevant workspaceId.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
invites
object[]

Response

A successful response.

The response is of type object.