Skip to main content
POST
/
v1
/
users
/
invites
Invite User to Dashboard
curl --request POST \
  --url https://sandbox-api.borderless.xyz/v1/users/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "businessTitle": "Manager",
  "role": "OWNER"
}
'
{
  "user": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "businessTitle": "<string>",
    "role": "OWNER",
    "deleted": true,
    "deletedAt": "2023-11-07T05:31:56Z",
    "mfaEnabled": true,
    "dashboardPermissions": [
      "OrganizationApiKeysGenerate"
    ]
  },
  "userInviteUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
email
string<email>
required

The email address of the user to invite.

Example:

"john.doe@example.com"

​
firstName
string

The first name of the invited user.

Required string length: 2 - 50
Example:

"John"

​
lastName
string

The last name of the invited user.

Required string length: 3 - 50
Example:

"Doe"

​
businessTitle
string

The business title of the invited user.

Required string length: 3 - 50
Example:

"Manager"

​
role
enum<string>

The role assigned to the invited user in the dashboard. Learn more about roles at User Management Guide.

Available options:
OWNER,
VIEWER,
CUSTOM
Example:

"OWNER"

Response

201 - application/json

Invited user data and userInviteUrl to set up a new password.

​
user
object
required
​
userInviteUrl
string
required