Update an employee

curl --request PATCH \
  --url https://api.getprimo.com/employees/{employeeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "personalEmail": "jsmith@example.com",
  "phone": "<string>",
  "picture": "<string>",
  "managerId": "<string>",
  "job": {
    "name": "<string>",
    "id": "<string>"
  },
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workLocation": {
    "name": "<string>",
    "id": "<string>"
  },
  "legalEntity": {
    "name": "<string>",
    "id": "<string>"
  }
}
'

import requests

url = "https://api.getprimo.com/employees/{employeeId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "personalEmail": "jsmith@example.com",
    "phone": "<string>",
    "picture": "<string>",
    "managerId": "<string>",
    "job": {
        "name": "<string>",
        "id": "<string>"
    },
    "teams": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "workLocation": {
        "name": "<string>",
        "id": "<string>"
    },
    "legalEntity": {
        "name": "<string>",
        "id": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    personalEmail: 'jsmith@example.com',
    phone: '<string>',
    picture: '<string>',
    managerId: '<string>',
    job: {name: '<string>', id: '<string>'},
    teams: [{id: '<string>', name: '<string>'}],
    workLocation: {name: '<string>', id: '<string>'},
    legalEntity: {name: '<string>', id: '<string>'}
  })
};

fetch('https://api.getprimo.com/employees/{employeeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/employees/{employeeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'personalEmail' => 'jsmith@example.com',
    'phone' => '<string>',
    'picture' => '<string>',
    'managerId' => '<string>',
    'job' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'teams' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'workLocation' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'legalEntity' => [
        'name' => '<string>',
        'id' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/employees/{employeeId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.getprimo.com/employees/{employeeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employees/{employeeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "onboardingStatus": "PENDING",
  "offboardingStatus": "PENDING",
  "deviceIds": [
    "<string>"
  ],
  "accessoryIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "employmentType": "INTERNAL",
  "isRemote": true,
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "managerId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terminationDate": "2023-11-07T05:31:56Z",
  "personalEmail": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "complement": "<string>",
    "countryCode": "<string>",
    "phone": "<string>"
  }
}

PATCH

employees

{employeeId}

Update an employee

curl --request PATCH \
  --url https://api.getprimo.com/employees/{employeeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "personalEmail": "jsmith@example.com",
  "phone": "<string>",
  "picture": "<string>",
  "managerId": "<string>",
  "job": {
    "name": "<string>",
    "id": "<string>"
  },
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workLocation": {
    "name": "<string>",
    "id": "<string>"
  },
  "legalEntity": {
    "name": "<string>",
    "id": "<string>"
  }
}
'

import requests

url = "https://api.getprimo.com/employees/{employeeId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "personalEmail": "jsmith@example.com",
    "phone": "<string>",
    "picture": "<string>",
    "managerId": "<string>",
    "job": {
        "name": "<string>",
        "id": "<string>"
    },
    "teams": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "workLocation": {
        "name": "<string>",
        "id": "<string>"
    },
    "legalEntity": {
        "name": "<string>",
        "id": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    personalEmail: 'jsmith@example.com',
    phone: '<string>',
    picture: '<string>',
    managerId: '<string>',
    job: {name: '<string>', id: '<string>'},
    teams: [{id: '<string>', name: '<string>'}],
    workLocation: {name: '<string>', id: '<string>'},
    legalEntity: {name: '<string>', id: '<string>'}
  })
};

fetch('https://api.getprimo.com/employees/{employeeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getprimo.com/employees/{employeeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'personalEmail' => 'jsmith@example.com',
    'phone' => '<string>',
    'picture' => '<string>',
    'managerId' => '<string>',
    'job' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'teams' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'workLocation' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'legalEntity' => [
        'name' => '<string>',
        'id' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getprimo.com/employees/{employeeId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.getprimo.com/employees/{employeeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employees/{employeeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"managerId\": \"<string>\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "jobs": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "onboardingStatus": "PENDING",
  "offboardingStatus": "PENDING",
  "deviceIds": [
    "<string>"
  ],
  "accessoryIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "employmentType": "INTERNAL",
  "isRemote": true,
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "managerId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "terminationDate": "2023-11-07T05:31:56Z",
  "personalEmail": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "complement": "<string>",
    "countryCode": "<string>",
    "phone": "<string>"
  }
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

employeeId

string

required

Body

application/json

firstName

string

First name of the employee

Minimum string length: 1

lastName

string

Last name of the employee

Minimum string length: 1

string<email>

Work email address of the employee

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

personalEmail

string<email> | null

Personal email address of the employee

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phone

string | null

Phone number of the employee

gender

enum<string> | null

Gender of the employee

Available options:

MALE,

FEMALE,

OTHER,

PREFER_NOT_TO_DISCLOSE

picture

string | null

URL of the employee profile picture

managerId

string | null

ID of the manager employee

employmentType

enum<string>

Employment type of the employee

Available options:

INTERNAL,

CONTRACTOR

job

object | null

Job title. Created if it does not exist yet.

Show child attributes

teams

object[]

Teams the employee belongs to. Replaces the current set. Teams are created if they do not exist yet.

Show child attributes

workLocation

object | null

Work location. Created if it does not exist yet.

Show child attributes

legalEntity

object | null

Legal entity. Created if it does not exist yet.

Show child attributes

Response

default - application/json

string

required

firstName

string

required

lastName

string

required

string

required

teams

object[]

required

Teams the employee belongs to. Empty only when no team is assigned — group by name to count per team.

Show child attributes

jobs

object[]

required

Job titles held by the employee. Empty only when no job title is assigned.

Show child attributes

groups

object[]

required

Employee groups the employee belongs to.

Show child attributes

onboardingStatus

enum<string> | null

required

Null when the employee has no onboarding.

Available options:

PENDING,

SCHEDULED,

IN_PROGRESS,

CLOSED,

CANCELED

offboardingStatus

enum<string> | null

required

Null when the employee has no offboarding.

Available options:

PENDING,

SCHEDULED,

IN_PROGRESS,

CLOSED,

CANCELED

deviceIds

string[]

required

Ids of the devices assigned to the employee.

accessoryIds

string[]

required

Ids of the accessories assigned to the employee.

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

employmentType

enum<string>

required

Employment type of the employee

Available options:

INTERNAL,

CONTRACTOR

isRemote

boolean

required

Whether the employee works remotely. Derived from the absence of a work location: an employee with no assigned work location has no office to deliver equipment to and is treated as remote.

workLocation

object | null

Office the employee is attached to. Null for a remote employee.

Show child attributes

legalEntity

object | null

Legal entity employing them.

Show child attributes

managerId

string | null

Id of the manager employee.

startDate

string<date-time> | null

Employment start date (ISO 8601).

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

terminationDate

string<date-time> | null

Employment end date (ISO 8601).

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

personalEmail

string | null

Personal email address of the employee

address

object | null

Personal (home) address of the employee, when known. Use it as the HOME shipping address when ordering equipment for a remote employee. Null when the employee record has no address — ask for one instead of composing it.

Show child attributes

Getting Started

API Reference

Update an employee

Authorizations

Path Parameters

Body

Response