Invite a user to your organization

POST 
/v1/users/invite

This route allows you to invite a user to your Port organization.

To learn more about users, roles, and teams, check out the documentation.

Request

Query Parameters

notify boolean
If true, the invitee will receive an email notification.

Default value: true

application/json

Body

required

invitee

object

required

The details of the user you want to invite.


emailstringrequired

The user's email address.


Possible values: Value must match regular expression ^[^;#/\?\s][^;#/\?]*[^;#/\?\s]$

rolesstring[]

The roles you want to assign to the user.


teamsstring[]

The names of the teams you want to assign the user to.

Responses

200

Invited successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

Example (from schema)

{
  "ok": true
}