Skip to main content
PATCH
/
teammates
/
{TEAMMATE_ID}
cURL
curl --request PATCH \
  --url https://api.alpharun.com/api/v1/teammates/{TEAMMATE_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "manager_id": "<string>",
  "teammate_groups": {
    "add": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "remove": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "is_active": true
}
'
{
  "data": {
    "teammate": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "manager_id": "660e8400-e29b-41d4-a716-446655440001",
      "teammate_group_ids": [
        "770e8400-e29b-41d4-a716-446655440002",
        "880e8400-e29b-41d4-a716-446655440003"
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
TEAMMATE_ID
string
required

The teammate identifier, which can be either its UUID or its email. When using an email, the format should be alt:email:<email>.

Body

application/json
​
first_name
string

First name of the teammate

​
last_name
string

Last name of the teammate

​
manager_id
string | null

The manager identifier, which can be a UUID, an email using the format alt:email:<email>, or null to clear the manager

​
teammate_groups
object

Object specifying group membership changes

​
is_active
boolean

Set to true to activate the teammate or false to deactivate them

Response

Teammate updated successfully

​
data
object