Skip to main content
POST
/
teammates
cURL
curl --request POST \
  --url https://api.alpharun.com/api/v1/teammates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "editor",
  "first_name": "<string>",
  "last_name": "<string>",
  "manager_id": "<string>",
  "group_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "teammate": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "manager_id": null,
      "teammate_group_ids": []
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Teammate invitation details. Optional parameters (first_name, last_name, manager_id, group_ids) are only set when creating a new teammate, not when re-inviting.

​
email
string<email>
required

Email address of the teammate to invite

​
role
enum<string>
required

Role to assign to the teammate

Available options:
editor,
reviewer,
team_member
​
first_name
string

First name of the teammate (only set when creating a new teammate)

​
last_name
string

Last name of the teammate (only set when creating a new teammate)

​
manager_id
string

Manager identifier, which can be a UUID or an email using the format alt:email:<email> (only set when creating a new teammate)

​
group_ids
string<uuid>[]

List of teammate group IDs to add the teammate to (only set when creating a new teammate)

Response

Existing teammate was re-invited (use PATCH to update their properties)

​
data
object