PATCH /external/schedule/{externalId}
It's possible to always update the pincode for schedules which are not activated. However in some scenario's you would like to update the pincode when the schedule is activated. This is a similar call as 'Update schedule' but only with the PIN node.
Request Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| externalId* | String | Schedule external id |
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters (for message body)
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| PIN | string (4) | PIN for candidates |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/external/schedule/EXT_sch_1
Sample Request
{
"PIN": "1234"
}
Sample Response
{
"Content": null,
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible errors: Invalid input data (all fields in message body are empty) Schedule hasn't been found by external id Can’t update activated schedule Scheduler hasn’t been set in External API settings Selected scheduler no longer has permission to create, update and delete schedules |
| 500 | Internal server error |