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

Default value: true

If true, the invitee will receive an email notification.

application/json

Body

required

invitee

object

required

The details of the user you want to invite.


email stringrequired

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

The user's email address.


roles string[]

The roles you want to assign to the user.


teams string[]

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

Responses

200

Default Response

Loading...