Team / Team Members /

Invite team member

Sends an invitation email to add a user to a team.

Required permission

Account > Admin > Members > Manage

Path parameters

teamId
string required
ID of the team

Request body

{object}

email
string required
Email of the user to invite.
pattern
^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
roles
[array]
Role IDs to assign to the invited member.

string

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/teams/{teamId}/members

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"email":"user@example.com"}' \
  https://api.northflank.com/v1/teams/{teamId}/members

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}