Update an employee creation intent

curl --request PATCH \
  --url https://api.getprimo.com/employee-creation-intents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "personalEmail": "jsmith@example.com",
  "phone": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "job": {
    "name": "<string>",
    "id": "<string>"
  },
  "legalEntity": {
    "name": "<string>",
    "id": "<string>"
  },
  "workLocation": {
    "name": "<string>",
    "id": "<string>"
  },
  "teams": [
    {
      "name": "<string>",
      "id": "<string>"
    }
  ],
  "managerId": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "name": "<string>",
    "contactName": "<string>",
    "phone": "<string>",
    "complement": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  }
}
'

import requests

url = "https://api.getprimo.com/employee-creation-intents/{intentId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "personalEmail": "jsmith@example.com",
    "phone": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "job": {
        "name": "<string>",
        "id": "<string>"
    },
    "legalEntity": {
        "name": "<string>",
        "id": "<string>"
    },
    "workLocation": {
        "name": "<string>",
        "id": "<string>"
    },
    "teams": [
        {
            "name": "<string>",
            "id": "<string>"
        }
    ],
    "managerId": "<string>",
    "address": {
        "street": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "name": "<string>",
        "contactName": "<string>",
        "phone": "<string>",
        "complement": "<string>",
        "country": "<string>",
        "countryCode": "<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>',
    startDate: '2023-11-07T05:31:56Z',
    job: {name: '<string>', id: '<string>'},
    legalEntity: {name: '<string>', id: '<string>'},
    workLocation: {name: '<string>', id: '<string>'},
    teams: [{name: '<string>', id: '<string>'}],
    managerId: '<string>',
    address: {
      street: '<string>',
      postalCode: '<string>',
      city: '<string>',
      name: '<string>',
      contactName: '<string>',
      phone: '<string>',
      complement: '<string>',
      country: '<string>',
      countryCode: '<string>'
    }
  })
};

fetch('https://api.getprimo.com/employee-creation-intents/{intentId}', 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/employee-creation-intents/{intentId}",
  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>',
    'startDate' => '2023-11-07T05:31:56Z',
    'job' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'legalEntity' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'workLocation' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'teams' => [
        [
                'name' => '<string>',
                'id' => '<string>'
        ]
    ],
    'managerId' => '<string>',
    'address' => [
        'street' => '<string>',
        'postalCode' => '<string>',
        'city' => '<string>',
        'name' => '<string>',
        'contactName' => '<string>',
        'phone' => '<string>',
        'complement' => '<string>',
        'country' => '<string>',
        'countryCode' => '<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/employee-creation-intents/{intentId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<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/employee-creation-intents/{intentId}")
  .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  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employee-creation-intents/{intentId}")

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  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "onboardingId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "personalEmail": "<string>",
  "phone": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "employmentType": "INTERNAL",
  "job": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "managerId": "<string>",
  "address": {
    "name": "<string>",
    "contactName": "<string>",
    "phone": "<string>",
    "street": "<string>",
    "complement": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  },
  "employeeId": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Onboardings

Update an employee creation intent

Change the HR information an employee creation intent will create the employee from, before it executes — typically while its task sleeps until its date, or after a refusal left it PENDING. Only the fields you send change (teams is replaced whole); null clears one. The onboarding cannot change: create a new intent for another onboarding. Refused with INTENT_NOT_FOUND, INTENT_ALREADY_EXECUTED once executed, TICKET_CLOSED when its task is completed or cancelled, MANAGER_NOT_FOUND. The task cannot be marked done by hand: updateTaskStatus refuses it, and it completes once Primo has created the employee. createEmployee only creates a record with no onboarding or task, and completeOnboarding closes the whole onboarding without this task; use the employee creation intent for an EMPLOYEE_CREATION task a ticket tracks.

PATCH

employee-creation-intents

{intentId}

curl --request PATCH \
  --url https://api.getprimo.com/employee-creation-intents/{intentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "personalEmail": "jsmith@example.com",
  "phone": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "job": {
    "name": "<string>",
    "id": "<string>"
  },
  "legalEntity": {
    "name": "<string>",
    "id": "<string>"
  },
  "workLocation": {
    "name": "<string>",
    "id": "<string>"
  },
  "teams": [
    {
      "name": "<string>",
      "id": "<string>"
    }
  ],
  "managerId": "<string>",
  "address": {
    "street": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "name": "<string>",
    "contactName": "<string>",
    "phone": "<string>",
    "complement": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  }
}
'

import requests

url = "https://api.getprimo.com/employee-creation-intents/{intentId}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "personalEmail": "jsmith@example.com",
    "phone": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "job": {
        "name": "<string>",
        "id": "<string>"
    },
    "legalEntity": {
        "name": "<string>",
        "id": "<string>"
    },
    "workLocation": {
        "name": "<string>",
        "id": "<string>"
    },
    "teams": [
        {
            "name": "<string>",
            "id": "<string>"
        }
    ],
    "managerId": "<string>",
    "address": {
        "street": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "name": "<string>",
        "contactName": "<string>",
        "phone": "<string>",
        "complement": "<string>",
        "country": "<string>",
        "countryCode": "<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>',
    startDate: '2023-11-07T05:31:56Z',
    job: {name: '<string>', id: '<string>'},
    legalEntity: {name: '<string>', id: '<string>'},
    workLocation: {name: '<string>', id: '<string>'},
    teams: [{name: '<string>', id: '<string>'}],
    managerId: '<string>',
    address: {
      street: '<string>',
      postalCode: '<string>',
      city: '<string>',
      name: '<string>',
      contactName: '<string>',
      phone: '<string>',
      complement: '<string>',
      country: '<string>',
      countryCode: '<string>'
    }
  })
};

fetch('https://api.getprimo.com/employee-creation-intents/{intentId}', 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/employee-creation-intents/{intentId}",
  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>',
    'startDate' => '2023-11-07T05:31:56Z',
    'job' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'legalEntity' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'workLocation' => [
        'name' => '<string>',
        'id' => '<string>'
    ],
    'teams' => [
        [
                'name' => '<string>',
                'id' => '<string>'
        ]
    ],
    'managerId' => '<string>',
    'address' => [
        'street' => '<string>',
        'postalCode' => '<string>',
        'city' => '<string>',
        'name' => '<string>',
        'contactName' => '<string>',
        'phone' => '<string>',
        'complement' => '<string>',
        'country' => '<string>',
        'countryCode' => '<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/employee-creation-intents/{intentId}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"personalEmail\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<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/employee-creation-intents/{intentId}")
  .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  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/employee-creation-intents/{intentId}")

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  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"job\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"legalEntity\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"workLocation\": {\n    \"name\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"teams\": [\n    {\n      \"name\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"managerId\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"city\": \"<string>\",\n    \"name\": \"<string>\",\n    \"contactName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"complement\": \"<string>\",\n    \"country\": \"<string>\",\n    \"countryCode\": \"<string>\"\n  }\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "onboardingId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "personalEmail": "<string>",
  "phone": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "employmentType": "INTERNAL",
  "job": {
    "id": "<string>",
    "name": "<string>"
  },
  "legalEntity": {
    "id": "<string>",
    "name": "<string>"
  },
  "workLocation": {
    "id": "<string>",
    "name": "<string>"
  },
  "teams": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "managerId": "<string>",
  "address": {
    "name": "<string>",
    "contactName": "<string>",
    "phone": "<string>",
    "street": "<string>",
    "complement": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  },
  "employeeId": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

intentId

string

required

Body

application/json

firstName

string | null

Minimum string length: 1

lastName

string | null

Minimum string length: 1

string<email> | null

Work email address the employee is created with.

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

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

phone

string | null

startDate

string<date-time> | null

First day of the employee (ISO 8601), past or future.

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> | null

Available options:

INTERNAL,

CONTRACTOR

job

object | null

Job title.

Show child attributes

legalEntity

object | null

Show child attributes

workLocation

object | null

Office. Null for a remote employee.

Show child attributes

teams

object[]

Teams the employee joins, replaced whole.

Show child attributes

managerId

string | null

Primo employee id of the manager, from getEmployees.

Pattern: ^[a-f\d]{24}$

address

object | null

Personal (home) address of the employee.

Show child attributes

Response

default - application/json

string

required

Intent id — pass it to updateEmployeeCreationIntent and executeEmployeeCreationIntent

taskId

string | null

required

The EMPLOYEE_CREATION task that tracks this employee creation

ticketId

string | null

required

The ticket holding that task: the parentTicketId sent, or the one Primo opened. Null if it could not be read back.

onboardingId

string

required

firstName

string | null

required

lastName

string | null

required

string | null

required

personalEmail

string | null

required

phone

string | null

required

startDate

string<date-time> | null

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> | null

required

Available options:

INTERNAL,

CONTRACTOR

job

object | null

required

Show child attributes

legalEntity

object | null

required

Show child attributes

workLocation

object | null

required

Show child attributes

teams

object[]

required

Show child attributes

managerId

string | null

required

address

object | null

required

Show child attributes

employeeId

string | null

required

The employee created on execute, null until then

executedAt

string<date-time> | null

required

When the intent was executed; null while it can still change

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))$

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))$

Get started

API Reference

Update an employee creation intent

Authorizations

Path Parameters

Body

Response