Skip to content
/
Update an employee

Update an employee

Request

Security
x-api-key
Path
idstringrequired

Unique identifier for the employee

Bodyapplication/json
emailstring, (email)

A new primary email address for the employee. This must be one of the known email addresses for the employee.

firstNamestring

A new first name for the employee

lastNamestring

A new last name for the employee

licensedboolean

Set whether the employee is licensed on the Push platform

groupsArray of strings, <= 300 items

Set the groups an employee is in (this will overwrite the existing groups)

chatopsEnabledbooleandeprecated

Set whether the employee has ChatOps enabled

Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.

PATCH
/v1/employees/{id}
curl -i -X PATCH \
  'https://api.pushsecurity.com/v1/employees/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK. Returns null if you unlicense an employee that hasn't got any accounts

Bodyapplication/json
One of:

Returned when unlicensing an employee

string or null(Employee)
Response
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "email": "john.hill@example.com",
  "knownEmails": [
    "john.hill@example.com",
    "jhill@example.com"
  ],
  "firstName": "John",
  "lastName": "Hill",
  "department": "Security Engineering",
  "location": "New York",
  "licensed": true,
  "chatopsEnabled": true,
  "groups": [
    "engineering",
    "marketing"
  ],
  "creationTimestamp": 1698669223
}