v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Teammates

Update teammate

Update a teammate.

Required scope: teammates:write

patch/teammates/{teammate_id}

Path parameters

teammate_idstring required

The teammate ID. Alternatively, you can supply an email as a resource alias.

Request body

usernamestring

New username. It must be unique and can only contains lowercase letters, numbers and underscores.

first_namestring

New first name

last_namestring

New last name

is_availableboolean

New availability status

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example request

{
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}

Response

No content