Skip to content
/
Merge employees

Merge employees

Request

Security
x-api-key
Path
idstringrequired

Unique identifier for the employee

Bodyapplication/jsonrequired

Merge a list of employees with the primary one given.

secondaryEmployeeIdsArray of strings, [ 1 .. 5 ] itemsrequired

A list of employee IDs.

Example:
[
  "72d0347a-2663-4ef5-b1c5-df39163f1603",
  "87569da6-fb7a-4df7-8ce2-246c14044911"
]
POST
/v1/employees/{id}/merge
curl -i -X POST \
  'https://api.pushsecurity.com/v1/employees/{id}/merge' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "secondaryEmployeeIds": [
      "72d0347a-2663-4ef5-b1c5-df39163f1603",
      "87569da6-fb7a-4df7-8ce2-246c14044911"
    ]
  }'

Responses

OK. Returns the details of the primary employee.

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"
knownEmailsArray of strings

All the known email addresses of the employee

Example:
[
  "john.hill@example.com",
  "jhill@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
groupsArray of strings

Groups the employee is in

Example:
[
  "engineering",
  "marketing"
]
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",
  "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
}