Update the onboarding settings

curl --request PATCH \
  --url https://api.getprimo.com/onboarding-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailIncluded": true,
  "provisioningIncluded": true,
  "equipmentIncluded": true,
  "equipmentHandledByAi": true,
  "addPrimoAiAgent": true,
  "equipmentMdmEnrollment": true,
  "saasApplicationSuggestions": true,
  "emailScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "provisioningScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "equipmentScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "automaticProcessingActions": [],
  "defaultTaskOwner": {
    "employeeId": "<string>",
    "userId": "<string>"
  },
  "defaultTaskSubscribers": [
    {
      "employeeId": "<string>",
      "userId": "<string>"
    }
  ],
  "taskSettings": [
    {
      "owner": {
        "employeeId": "<string>",
        "userId": "<string>"
      },
      "dueDateNumberDaysBefore": 0,
      "scheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
      }
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/onboarding-settings"

payload = {
    "emailIncluded": True,
    "provisioningIncluded": True,
    "equipmentIncluded": True,
    "equipmentHandledByAi": True,
    "addPrimoAiAgent": True,
    "equipmentMdmEnrollment": True,
    "saasApplicationSuggestions": True,
    "emailScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "provisioningScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "equipmentScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "automaticProcessingActions": [],
    "defaultTaskOwner": {
        "employeeId": "<string>",
        "userId": "<string>"
    },
    "defaultTaskSubscribers": [
        {
            "employeeId": "<string>",
            "userId": "<string>"
        }
    ],
    "taskSettings": [
        {
            "owner": {
                "employeeId": "<string>",
                "userId": "<string>"
            },
            "dueDateNumberDaysBefore": 0,
            "scheduling": {
                "numberDaysBefore": 0,
                "time": "<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({
    emailIncluded: true,
    provisioningIncluded: true,
    equipmentIncluded: true,
    equipmentHandledByAi: true,
    addPrimoAiAgent: true,
    equipmentMdmEnrollment: true,
    saasApplicationSuggestions: true,
    emailScheduling: {numberDaysBefore: 0, time: '<string>'},
    provisioningScheduling: {numberDaysBefore: 0, time: '<string>'},
    equipmentScheduling: {numberDaysBefore: 0, time: '<string>'},
    automaticProcessingActions: [],
    defaultTaskOwner: {employeeId: '<string>', userId: '<string>'},
    defaultTaskSubscribers: [{employeeId: '<string>', userId: '<string>'}],
    taskSettings: [
      {
        owner: {employeeId: '<string>', userId: '<string>'},
        dueDateNumberDaysBefore: 0,
        scheduling: {numberDaysBefore: 0, time: '<string>'}
      }
    ]
  })
};

fetch('https://api.getprimo.com/onboarding-settings', 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/onboarding-settings",
  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([
    'emailIncluded' => true,
    'provisioningIncluded' => true,
    'equipmentIncluded' => true,
    'equipmentHandledByAi' => true,
    'addPrimoAiAgent' => true,
    'equipmentMdmEnrollment' => true,
    'saasApplicationSuggestions' => true,
    'emailScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'provisioningScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'equipmentScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'automaticProcessingActions' => [
        
    ],
    'defaultTaskOwner' => [
        'employeeId' => '<string>',
        'userId' => '<string>'
    ],
    'defaultTaskSubscribers' => [
        [
                'employeeId' => '<string>',
                'userId' => '<string>'
        ]
    ],
    'taskSettings' => [
        [
                'owner' => [
                                'employeeId' => '<string>',
                                'userId' => '<string>'
                ],
                'dueDateNumberDaysBefore' => 0,
                'scheduling' => [
                                'numberDaysBefore' => 0,
                                'time' => '<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/onboarding-settings"

	payload := strings.NewReader("{\n  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\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/onboarding-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/onboarding-settings")

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  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\n  ]\n}"

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

{
  "emailIncluded": true,
  "provisioningIncluded": true,
  "equipmentIncluded": true,
  "equipmentHandledByAi": true,
  "addPrimoAiAgent": true,
  "equipmentMdmEnrollment": true,
  "saasApplicationSuggestions": true,
  "emailCreationChoice": "CREATE",
  "automaticProcessingActions": [
    "EMPLOYEE_INFORMATION"
  ],
  "defaultTaskSubscribers": [
    {
      "type": "EMPLOYEE",
      "employeeId": "<string>",
      "userId": "<string>"
    }
  ],
  "taskSettings": [
    {
      "actionType": "EMPLOYEE_INFORMATION",
      "owner": {
        "type": "EMPLOYEE",
        "employeeId": "<string>",
        "userId": "<string>"
      },
      "dueDateNumberDaysBefore": 0,
      "scheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
      }
    }
  ],
  "emailExistingAddressHandling": "USE_AS_IS",
  "emailScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "provisioningScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "equipmentScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "defaultTaskOwner": {
    "type": "EMPLOYEE",
    "employeeId": "<string>",
    "userId": "<string>"
  },
  "defaultTaskPriority": "LOW"
}

Onboardings

Update the onboarding settings

Change the company onboarding settings — the steps every onboarding includes, their owners, due dates and scheduling, the default ticket owner, priority and subscribers, and the Primo AI agent options. Only the fields you send are changed; everything else keeps its stored value, so send just what the user asked to change rather than the whole object. defaultTaskOwner, owner and defaultTaskSubscribers take a Primo employee id (type EMPLOYEE) or the Clerk user id of an admin with no employee record (type EXTERNAL_ADMIN) — look the person up with getEmployees first; a person who does not belong to the company is refused. Sending null clears a field. The new settings apply to onboardings created afterwards, never to the ones already open. Call getOnboardingSettings first so you can tell the user what the change replaces.

PATCH

onboarding-settings

curl --request PATCH \
  --url https://api.getprimo.com/onboarding-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailIncluded": true,
  "provisioningIncluded": true,
  "equipmentIncluded": true,
  "equipmentHandledByAi": true,
  "addPrimoAiAgent": true,
  "equipmentMdmEnrollment": true,
  "saasApplicationSuggestions": true,
  "emailScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "provisioningScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "equipmentScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "automaticProcessingActions": [],
  "defaultTaskOwner": {
    "employeeId": "<string>",
    "userId": "<string>"
  },
  "defaultTaskSubscribers": [
    {
      "employeeId": "<string>",
      "userId": "<string>"
    }
  ],
  "taskSettings": [
    {
      "owner": {
        "employeeId": "<string>",
        "userId": "<string>"
      },
      "dueDateNumberDaysBefore": 0,
      "scheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
      }
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/onboarding-settings"

payload = {
    "emailIncluded": True,
    "provisioningIncluded": True,
    "equipmentIncluded": True,
    "equipmentHandledByAi": True,
    "addPrimoAiAgent": True,
    "equipmentMdmEnrollment": True,
    "saasApplicationSuggestions": True,
    "emailScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "provisioningScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "equipmentScheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
    },
    "automaticProcessingActions": [],
    "defaultTaskOwner": {
        "employeeId": "<string>",
        "userId": "<string>"
    },
    "defaultTaskSubscribers": [
        {
            "employeeId": "<string>",
            "userId": "<string>"
        }
    ],
    "taskSettings": [
        {
            "owner": {
                "employeeId": "<string>",
                "userId": "<string>"
            },
            "dueDateNumberDaysBefore": 0,
            "scheduling": {
                "numberDaysBefore": 0,
                "time": "<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({
    emailIncluded: true,
    provisioningIncluded: true,
    equipmentIncluded: true,
    equipmentHandledByAi: true,
    addPrimoAiAgent: true,
    equipmentMdmEnrollment: true,
    saasApplicationSuggestions: true,
    emailScheduling: {numberDaysBefore: 0, time: '<string>'},
    provisioningScheduling: {numberDaysBefore: 0, time: '<string>'},
    equipmentScheduling: {numberDaysBefore: 0, time: '<string>'},
    automaticProcessingActions: [],
    defaultTaskOwner: {employeeId: '<string>', userId: '<string>'},
    defaultTaskSubscribers: [{employeeId: '<string>', userId: '<string>'}],
    taskSettings: [
      {
        owner: {employeeId: '<string>', userId: '<string>'},
        dueDateNumberDaysBefore: 0,
        scheduling: {numberDaysBefore: 0, time: '<string>'}
      }
    ]
  })
};

fetch('https://api.getprimo.com/onboarding-settings', 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/onboarding-settings",
  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([
    'emailIncluded' => true,
    'provisioningIncluded' => true,
    'equipmentIncluded' => true,
    'equipmentHandledByAi' => true,
    'addPrimoAiAgent' => true,
    'equipmentMdmEnrollment' => true,
    'saasApplicationSuggestions' => true,
    'emailScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'provisioningScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'equipmentScheduling' => [
        'numberDaysBefore' => 0,
        'time' => '<string>'
    ],
    'automaticProcessingActions' => [
        
    ],
    'defaultTaskOwner' => [
        'employeeId' => '<string>',
        'userId' => '<string>'
    ],
    'defaultTaskSubscribers' => [
        [
                'employeeId' => '<string>',
                'userId' => '<string>'
        ]
    ],
    'taskSettings' => [
        [
                'owner' => [
                                'employeeId' => '<string>',
                                'userId' => '<string>'
                ],
                'dueDateNumberDaysBefore' => 0,
                'scheduling' => [
                                'numberDaysBefore' => 0,
                                'time' => '<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/onboarding-settings"

	payload := strings.NewReader("{\n  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\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/onboarding-settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/onboarding-settings")

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  \"emailIncluded\": true,\n  \"provisioningIncluded\": true,\n  \"equipmentIncluded\": true,\n  \"equipmentHandledByAi\": true,\n  \"addPrimoAiAgent\": true,\n  \"equipmentMdmEnrollment\": true,\n  \"saasApplicationSuggestions\": true,\n  \"emailScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"provisioningScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"equipmentScheduling\": {\n    \"numberDaysBefore\": 0,\n    \"time\": \"<string>\"\n  },\n  \"automaticProcessingActions\": [],\n  \"defaultTaskOwner\": {\n    \"employeeId\": \"<string>\",\n    \"userId\": \"<string>\"\n  },\n  \"defaultTaskSubscribers\": [\n    {\n      \"employeeId\": \"<string>\",\n      \"userId\": \"<string>\"\n    }\n  ],\n  \"taskSettings\": [\n    {\n      \"owner\": {\n        \"employeeId\": \"<string>\",\n        \"userId\": \"<string>\"\n      },\n      \"dueDateNumberDaysBefore\": 0,\n      \"scheduling\": {\n        \"numberDaysBefore\": 0,\n        \"time\": \"<string>\"\n      }\n    }\n  ]\n}"

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

{
  "emailIncluded": true,
  "provisioningIncluded": true,
  "equipmentIncluded": true,
  "equipmentHandledByAi": true,
  "addPrimoAiAgent": true,
  "equipmentMdmEnrollment": true,
  "saasApplicationSuggestions": true,
  "emailCreationChoice": "CREATE",
  "automaticProcessingActions": [
    "EMPLOYEE_INFORMATION"
  ],
  "defaultTaskSubscribers": [
    {
      "type": "EMPLOYEE",
      "employeeId": "<string>",
      "userId": "<string>"
    }
  ],
  "taskSettings": [
    {
      "actionType": "EMPLOYEE_INFORMATION",
      "owner": {
        "type": "EMPLOYEE",
        "employeeId": "<string>",
        "userId": "<string>"
      },
      "dueDateNumberDaysBefore": 0,
      "scheduling": {
        "numberDaysBefore": 0,
        "time": "<string>"
      }
    }
  ],
  "emailExistingAddressHandling": "USE_AS_IS",
  "emailScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "provisioningScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "equipmentScheduling": {
    "numberDaysBefore": 0,
    "time": "<string>"
  },
  "defaultTaskOwner": {
    "type": "EMPLOYEE",
    "employeeId": "<string>",
    "userId": "<string>"
  },
  "defaultTaskPriority": "LOW"
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

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

Body

application/json

emailIncluded

boolean

Whether the professional email step is part of every onboarding.

provisioningIncluded

boolean

Whether the SaaS provisioning step is part of every onboarding.

equipmentIncluded

boolean

Whether the equipment step is part of every onboarding.

equipmentHandledByAi

boolean

Whether the Primo AI agent drives the equipment step instead of a human owner.

addPrimoAiAgent

boolean

Whether the Primo AI agent is put on every onboarding ticket.

equipmentMdmEnrollment

boolean

Whether ordered devices are enrolled in MDM automatically.

saasApplicationSuggestions

boolean

Whether Primo suggests SaaS applications for the joiner.

emailCreationChoice

enum<string>

CREATE provisions a new address, EXISTING reuses the one the HRIS carries.

Available options:

CREATE,

EXISTING

emailExistingAddressHandling

enum<string> | null

Available options:

USE_AS_IS,

MANUAL_CONFIRMATION

emailScheduling

object | null

Show child attributes

provisioningScheduling

object | null

Show child attributes

equipmentScheduling

object | null

Show child attributes

automaticProcessingActions

enum<string>[]

Steps Primo executes without waiting for an admin to validate them.

Available options:

EMPLOYEE_INFORMATION,

EMPLOYEE_EMAIL,

EMPLOYEE_PROVISIONING,

EMPLOYEE_EQUIPMENT

defaultTaskOwner

object | null

Assignee of the onboarding ticket and of every step with no owner of its own. Null means unassigned.

Show child attributes

defaultTaskPriority

enum<string> | null

Available options:

LOW,

MEDIUM,

HIGH

defaultTaskSubscribers

object[]

Show child attributes

taskSettings

object[]

Per-step overrides of owner, due date and scheduling.

Show child attributes

Response

default - application/json

emailIncluded

boolean

required

Whether the professional email step is part of every onboarding.

provisioningIncluded

boolean

required

Whether the SaaS provisioning step is part of every onboarding.

equipmentIncluded

boolean

required

Whether the equipment step is part of every onboarding.

equipmentHandledByAi

boolean

required

Whether the Primo AI agent drives the equipment step instead of a human owner.

addPrimoAiAgent

boolean

required

Whether the Primo AI agent is put on every onboarding ticket.

equipmentMdmEnrollment

boolean

required

Whether ordered devices are enrolled in MDM automatically.

saasApplicationSuggestions

boolean

required

Whether Primo suggests SaaS applications for the joiner.

emailCreationChoice

enum<string>

required

CREATE provisions a new address, EXISTING reuses the one the HRIS carries.

Available options:

CREATE,

EXISTING

automaticProcessingActions

enum<string>[]

required

Steps Primo executes without waiting for an admin to validate them.

Available options:

EMPLOYEE_INFORMATION,

EMPLOYEE_EMAIL,

EMPLOYEE_PROVISIONING,

EMPLOYEE_EQUIPMENT

defaultTaskSubscribers

object[]

required

Show child attributes

taskSettings

object[]

required

Per-step overrides of owner, due date and scheduling.

Show child attributes

emailExistingAddressHandling

enum<string> | null

Available options:

USE_AS_IS,

MANUAL_CONFIRMATION

emailScheduling

object | null

Show child attributes

provisioningScheduling

object | null

Show child attributes

equipmentScheduling

object | null

Show child attributes

defaultTaskOwner

object | null

Assignee of the onboarding ticket and of every step with no owner of its own. Null means unassigned.

Show child attributes

defaultTaskPriority

enum<string> | null

Available options:

LOW,

MEDIUM,

HIGH

Getting Started

API Reference

Update the onboarding settings

Authorizations

Body

Response