Skip to content
/
Add an employee

Add an employee

Request

Security
x-api-key
Bodyapplication/jsonrequired

Create a new employee.

firstNamestringrequired

The first name of the employee.

Example:"John"
lastNamestringrequired

The last name of the employee.

Example:"Doe"
emailstringrequired

The email address of the employee.

Example:"john.doe@example.com"
enrolBrowserbooleanrequired

Whether the employee will be sent an email to ask them to install the Push browser extension.

Example:true
POST
/v1/employees
curl -i -X POST \
  https://api.pushsecurity.com/v1/employees \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "enrolBrowser": true
  }'

Responses

OK

Headers
any
Bodyapplication/json
idstring

Unique identifier for the employee

Example:"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
emailstring, (email)

Primary email address of the employee

Example:"john.hill@example.com"
firstNamestring

First name of the employee

Example:"John"
lastNamestring

Last name of the employee

Example:"Hill"
departmentstring

Department - as provided by connected API integrations

Example:"Security Engineering"
locationstring

Location - as provided by connected API integrations

Example:"New York"
licensedboolean

Whether the employee is licensed on the Push platform

Example:true
creationTimestampinteger

When this employee was created, formatted as a UNIX timestamp (in seconds)

Example:1698669223
chatopsEnabledbooleandeprecated

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.

Example:true
Response
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "email": "john.hill@example.com",
  "firstName": "John",
  "lastName": "Hill",
  "department": "Security Engineering",
  "location": "New York",
  "licensed": true,
  "chatopsEnabled": true,
  "creationTimestamp": 1698669223
}