Create or replace a person

curl --request PUT \
  --url https://app.trelica.com/api/people/v1/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamIds": [
    "65207c3ffa0d2abb07955316"
  ],
  "lineManagerEmail": "jane.smith@example.com",
  "employeeType": "Full-time",
  "personType": "Employee",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "location": "London, UK",
  "costCenter": "Customer Success",
  "employeeId": "123",
  "status": "New",
  "startDate": "2021-06-01T00:00:00Z"
}
'

const url = 'https://app.trelica.com/api/people/v1/{id}';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamIds: ['65207c3ffa0d2abb07955316'],
    lineManagerEmail: 'jane.smith@example.com',
    employeeType: 'Full-time',
    personType: 'Employee',
    firstName: 'John',
    lastName: 'Doe',
    email: 'john.doe@example.com',
    jobTitle: 'Customer Success Manager',
    location: 'London, UK',
    costCenter: 'Customer Success',
    employeeId: '123',
    status: 'New',
    startDate: '2021-06-01T00:00:00Z'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://app.trelica.com/api/people/v1/{id}"

payload = {
    "teamIds": ["65207c3ffa0d2abb07955316"],
    "lineManagerEmail": "jane.smith@example.com",
    "employeeType": "Full-time",
    "personType": "Employee",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "jobTitle": "Customer Success Manager",
    "location": "London, UK",
    "costCenter": "Customer Success",
    "employeeId": "123",
    "status": "New",
    "startDate": "2021-06-01T00:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://app.trelica.com/api/people/v1/{id}"

	payload := strings.NewReader("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}")

	req, _ := http.NewRequest("PUT", 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))

}

using RestSharp;


var options = new RestClientOptions("https://app.trelica.com/api/people/v1/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://app.trelica.com/api/people/v1/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.trelica.com/api/people/v1/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'teamIds' => [
        '65207c3ffa0d2abb07955316'
    ],
    'lineManagerEmail' => 'jane.smith@example.com',
    'employeeType' => 'Full-time',
    'personType' => 'Employee',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'email' => 'john.doe@example.com',
    'jobTitle' => 'Customer Success Manager',
    'location' => 'London, UK',
    'costCenter' => 'Customer Success',
    'employeeId' => '123',
    'status' => 'New',
    'startDate' => '2021-06-01T00:00:00Z'
  ]),
  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;
}

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://app.trelica.com/api/people/v1/{id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
  "teamIds": [
    "65207c3ffa0d2abb07955316"
  ],
  "lineManagerEmail": "jane.smith@example.com",
  "employeeType": "Full-time",
  "personType": "Employee",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "location": "London, UK",
  "costCenter": "Customer Success",
  "employeeId": "123",
  "status": "New",
  "startDate": "2021-06-01T00:00:00Z"
}'

require 'uri'
require 'net/http'

url = URI("https://app.trelica.com/api/people/v1/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}"

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

{
  "id": "123e4567e89b12d3a456426614174000",
  "employeeType": "Part-time",
  "personType": "Employee",
  "aliases": [
    "john.doe@example.com",
    "john@example.com",
    "j.doe@example.com",
    "johnny.d@example.com"
  ],
  "userName": "johndoe123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "organizationalUnit": "/",
  "loginName": "johndoe",
  "employeeId": "123",
  "status": "Active",
  "lineManager": {
    "id": "765e4321b98e21d3b456426614174000",
    "personType": "User",
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  },
  "teams": [
    {
      "id": "65207c3ffa0d2abb07955316",
      "name": "Customer Success"
    }
  ],
  "createdBy": {
    "userId": "321cba98-765e-4321-0d3b-456789abcdef",
    "name": "System",
    "email": "admin@example.com"
  },
  "createdDtm": "2020-03-09T06:09:26Z",
  "lastModifiedBy": {
    "userId": "321cba98-765e-4321-0d3b-456789abcdef",
    "name": "System",
    "email": "admin@example.com"
  },
  "lastModifiedDtm": "2024-05-26T01:01:43Z"
}

{
  "type": "about:blank",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "detail": "The request body failed validation. See errors for the offending fields.",
  "errors": {
    "email": [
      "The email field is required."
    ]
  },
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

{
  "type": "about:blank",
  "title": "Not found.",
  "status": 404,
  "detail": "The requested resource does not exist or you do not have access to it.",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

{
  "type": "about:blank",
  "title": "Conflict.",
  "status": 409,
  "detail": "The request conflicts with the current state (for example, the resource already exists).",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

People

Create or replace a person

Creates a new person, or fully replaces an existing one when an ID is supplied (in the route or in the body). When creating, the email address must not already be in use. Set the line manager with lineManagerId or lineManagerEmail. Team membership is replaced wholesale: supply either teams (by ID or name) or teamIds (not both) — omitting both removes the person’s manually-assigned teams.

Required scope: People.Write (Write access to people and teams)

PUT

api

people

{id}

Create or replace a person

curl --request PUT \
  --url https://app.trelica.com/api/people/v1/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamIds": [
    "65207c3ffa0d2abb07955316"
  ],
  "lineManagerEmail": "jane.smith@example.com",
  "employeeType": "Full-time",
  "personType": "Employee",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "location": "London, UK",
  "costCenter": "Customer Success",
  "employeeId": "123",
  "status": "New",
  "startDate": "2021-06-01T00:00:00Z"
}
'

const url = 'https://app.trelica.com/api/people/v1/{id}';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamIds: ['65207c3ffa0d2abb07955316'],
    lineManagerEmail: 'jane.smith@example.com',
    employeeType: 'Full-time',
    personType: 'Employee',
    firstName: 'John',
    lastName: 'Doe',
    email: 'john.doe@example.com',
    jobTitle: 'Customer Success Manager',
    location: 'London, UK',
    costCenter: 'Customer Success',
    employeeId: '123',
    status: 'New',
    startDate: '2021-06-01T00:00:00Z'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://app.trelica.com/api/people/v1/{id}"

payload = {
    "teamIds": ["65207c3ffa0d2abb07955316"],
    "lineManagerEmail": "jane.smith@example.com",
    "employeeType": "Full-time",
    "personType": "Employee",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "jobTitle": "Customer Success Manager",
    "location": "London, UK",
    "costCenter": "Customer Success",
    "employeeId": "123",
    "status": "New",
    "startDate": "2021-06-01T00:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://app.trelica.com/api/people/v1/{id}"

	payload := strings.NewReader("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}")

	req, _ := http.NewRequest("PUT", 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))

}

using RestSharp;


var options = new RestClientOptions("https://app.trelica.com/api/people/v1/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.put("https://app.trelica.com/api/people/v1/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.trelica.com/api/people/v1/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'teamIds' => [
        '65207c3ffa0d2abb07955316'
    ],
    'lineManagerEmail' => 'jane.smith@example.com',
    'employeeType' => 'Full-time',
    'personType' => 'Employee',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'email' => 'john.doe@example.com',
    'jobTitle' => 'Customer Success Manager',
    'location' => 'London, UK',
    'costCenter' => 'Customer Success',
    'employeeId' => '123',
    'status' => 'New',
    'startDate' => '2021-06-01T00:00:00Z'
  ]),
  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;
}

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://app.trelica.com/api/people/v1/{id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
  "teamIds": [
    "65207c3ffa0d2abb07955316"
  ],
  "lineManagerEmail": "jane.smith@example.com",
  "employeeType": "Full-time",
  "personType": "Employee",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "location": "London, UK",
  "costCenter": "Customer Success",
  "employeeId": "123",
  "status": "New",
  "startDate": "2021-06-01T00:00:00Z"
}'

require 'uri'
require 'net/http'

url = URI("https://app.trelica.com/api/people/v1/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamIds\": [\n    \"65207c3ffa0d2abb07955316\"\n  ],\n  \"lineManagerEmail\": \"jane.smith@example.com\",\n  \"employeeType\": \"Full-time\",\n  \"personType\": \"Employee\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"jobTitle\": \"Customer Success Manager\",\n  \"location\": \"London, UK\",\n  \"costCenter\": \"Customer Success\",\n  \"employeeId\": \"123\",\n  \"status\": \"New\",\n  \"startDate\": \"2021-06-01T00:00:00Z\"\n}"

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

{
  "id": "123e4567e89b12d3a456426614174000",
  "employeeType": "Part-time",
  "personType": "Employee",
  "aliases": [
    "john.doe@example.com",
    "john@example.com",
    "j.doe@example.com",
    "johnny.d@example.com"
  ],
  "userName": "johndoe123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Customer Success Manager",
  "organizationalUnit": "/",
  "loginName": "johndoe",
  "employeeId": "123",
  "status": "Active",
  "lineManager": {
    "id": "765e4321b98e21d3b456426614174000",
    "personType": "User",
    "name": "Jane Smith",
    "email": "jane.smith@example.com"
  },
  "teams": [
    {
      "id": "65207c3ffa0d2abb07955316",
      "name": "Customer Success"
    }
  ],
  "createdBy": {
    "userId": "321cba98-765e-4321-0d3b-456789abcdef",
    "name": "System",
    "email": "admin@example.com"
  },
  "createdDtm": "2020-03-09T06:09:26Z",
  "lastModifiedBy": {
    "userId": "321cba98-765e-4321-0d3b-456789abcdef",
    "name": "System",
    "email": "admin@example.com"
  },
  "lastModifiedDtm": "2024-05-26T01:01:43Z"
}

{
  "type": "about:blank",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "detail": "The request body failed validation. See errors for the offending fields.",
  "errors": {
    "email": [
      "The email field is required."
    ]
  },
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

{
  "type": "about:blank",
  "title": "Not found.",
  "status": 404,
  "detail": "The requested resource does not exist or you do not have access to it.",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

{
  "type": "about:blank",
  "title": "Conflict.",
  "status": 409,
  "detail": "The request conflicts with the current state (for example, the resource already exists).",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
}

Authorizations

Authorization

string

header

required

OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.

Scopes

People.Write

Write access to people and teams

Path Parameters

string

required

Optional SaaS Manager person ID (UUID) to replace. If omitted a new person is created.

Body

application/json

The details used to create or replace a person

string | null

The person's SaaS Manager ID. May be supplied here instead of in the route; must match the route id if both are given.

teamIds

string[] | null

Team memberships by team ID. Mutually exclusive with teams.

lineManagerEmail

string | null

Set the line manager by email address. Mutually exclusive with lineManager and lineManagerId.

lineManagerId

string | null

Set the line manager by SaaS Manager person ID. Mutually exclusive with lineManager and lineManagerEmail.

employeeType

string | null

A free-text employee type (e.g. full-time, part-time). Distinct from personType.

personType

enum<string> | null

Classifies the person: Employee, Contractor, ServiceAccount or External. Distinct from the free-text employeeType.

Available options:

Employee,

Contractor,

ServiceAccount,

External

aliases

string[] | null

Email addresses linked to this person

firstName

string | null

First name

lastName

string | null

Last name

string | null

Primary email address

jobTitle

string | null

Job title

location

string | null

A description of the user's location. A matching location is found or created when set.

costCenter

string | null

Cost center. A matching cost center is found or created when set.

The person's login name on the local domain. Used in conjunction with the SaaS Manager Browser Extension Helper to determine the identity of the logged in user.

timezone

string | null

The person's IANA time zone name, e.g. America/New_York

employeeId

string | null

Employee ID

lineManager

object | null

The person's line manager. On input, set it by the line manager's id or email (other fields are ignored); alternatively use lineManagerId or lineManagerEmail. These three forms are mutually exclusive.

Show child attributes

teams

object[] | null

The teams the person belongs to. When creating or replacing, supply teams by ID, or by name (a team is created if the name is not found); mutually exclusive with teamIds.

Show child attributes

startDate

string<date-time> | null

(ISO format) Date that the person joined the organization. Passing null clears the date.

leavingDate

string<date-time> | null

(ISO format) Date that the person left the organization or is due to lave. Passing null clears the date.

Response

A SaaS Manager person

string

The person's unique ID

employeeType

string

A free-text employee type (e.g. full-time, part-time). Distinct from personType.

personType

enum<string>

Classifies the person: Employee, Contractor, ServiceAccount or External. Distinct from the free-text employeeType.

Available options:

Employee,

Contractor,

ServiceAccount,

External

aliases

string[]

Email addresses linked to this person

userName

string

The user's logon name (from integrations)

firstName

string

First name

lastName

string

Last name

string

Primary email address

jobTitle

string

Job title

locationId

string

The location's unique identifier (derived from location)

location

string

A description of the user's location. A matching location is found or created when set.

locationCountryCode

string

The user's country (derived from location)

locationTimezone

string

The IANA time zone name of the user's location, e.g. America/New_York (derived from location)

costCenterId

string

The ID of the cost center (derived from costCenter)

costCenter

string

Cost center. A matching cost center is found or created when set.

organizationalUnit

string

The organizational unit, sourced from directory integrations (e.g. Google Workspace, Active Directory).

The person's login name on the local domain. Used in conjunction with the SaaS Manager Browser Extension Helper to determine the identity of the logged in user.

timezone

string

The person's IANA time zone name, e.g. America/New_York

employeeId

string

Employee ID

phoneNumber

string

Phone number

status

enum<string>

Status (new, terminated, etc)

Available options:

New,

Terminated,

Active,

Unknown

personalAddress

object

Home address

Show child attributes

lineManager

object

Show child attributes

teams

object[]

The teams the person belongs to. When creating or replacing, supply teams by ID, or by name (a team is created if the name is not found); mutually exclusive with teamIds.

Show child attributes

customFields

object

Custom field values

Show child attributes

startDate

string<date-time>

(ISO format) Date that the person joined the organization. Passing null clears the date.

leavingDate

string<date-time>

(ISO format) Date that the person left the organization or is due to lave. Passing null clears the date.

createdBy

object

The user that created the person record

Show child attributes

createdDtm

string<date-time>

The timestamp for when the person record was created

lastModifiedBy

object

The user that last modified the person record

Show child attributes

lastModifiedDtm

string<date-time>

The timestamp for when the person record was last modified