Untether LabsDevelopers

Error Reference

Every error the Untether Labs API returns.

Errors are identified by their type, which is this page's URL with the error's code as the fragment — an error listed here as shift-already-claimed arrives as https://developers.untetherlabs.com/errors#shift-already-claimed. Match on that rather than on the status code or the message, both of which are shared by many errors.

Every response carries the standard RFC-9457 members. The extension members listed below are additional to those.

400 Bad Request#

batch-size-exceeded

The request exceeded the maximum allowed batch size.

Show extension members
batchSizenumber
Required
maxBatchSizenumber
Required
inactive-integration

The requested operation requires an active integration.

invalid-balance-reset-rows

The requested balance reset rows are invalid.

invalid-punch-action

The requested punch action is invalid.

missing-historical-correction-acknowledgement

A historical correction acknowledgement is required to create a historical correction. For more information on historical corrections, see the dedicated guide.

negative-range

Time range end date must come after start date.

Show extension members
pathstring
provider-not-in-policy

The specified provider is not a member of the specified time off policy.

read-only-field

The request attempted to modify a read-only field.

Show extension members
pathsstring[]
Required
recurring-change-in-past

A recurring schedule change must take effect today or later in the company timezone.

Show extension members
fromDatestring
Required
todaystring
Required
recurring-schedule-closed

The requested recurring schedule is closed and cannot be modified.

report-parameter-validation

A report parameter did not pass validation, see message.

Show extension members
pathstring
messagestring
Required
rippling-validation

The time off request failed Rippling validation requirements.

Show extension members
messagestring
Required
errorCodestring
schedule-batch-item-failed

One staged change could not be applied, so nothing in the batch was saved.

Show extension members
indexinteger
Required

Position of the failed item in the queue, counting from 0.

itemTypestring
Required
causeobject
Required
typestring
Required
titlestring
Required
detailstring
skill-assignment-overlap

The requested skill assignment overlaps with an existing assignment for the same provider and skill.

team-not-configured-for-autoscheduling

The specified team has no AutoScheduler configuration, so a run cannot be created for it.

validation

Input validation failed.

Show extension members
pathstring
messagestring
Required

403 Forbidden#

unauthorized

You do not have permission to perform this action.

Show extension members
actionstring
Required
resourcestring
Required
reasonstring

404 Not Found#

api-client-not-found

A specified api client does not exist in the system.

appointment-not-found

A specified appointment does not exist in the system.

appointment-type-not-found

A specified appointmenttype does not exist in the system.

auto-scheduler-job-not-found

A specified auto scheduler job does not exist in the system.

auto-scheduler-snapshot-not-found

A specified auto scheduler snapshot does not exist in the system.

availability-exception-not-found

A specified availability exception does not exist in the system.

availability-lock-not-found

A specified availability lock does not exist in the system.

availability-not-found

A specified availability does not exist in the system.

balance-reset-upload-not-found

A specified balance reset upload does not exist in the system.

billing-document-not-found

A specified billing document does not exist in the system.

billing-invoice-not-found

A specified billing invoice does not exist in the system.

billing-not-enabled

Billing is not enabled for this company.

conversation-not-found

A specified conversation does not exist in the system.

cron-not-found

A specified cron does not exist in the system.

custom-field-not-found

A specified custom field does not exist in the system.

data-source-not-found

A specified data source does not exist in the system.

help-article-not-found

A specified help article does not exist in the system.

help-collection-not-found

A specified help collection does not exist in the system.

help-draft-not-found

A specified help draft does not exist in the system.

integration-not-found

A specified integration does not exist in the system.

job-not-found

A specified job does not exist in the system.

label-not-found

A specified label does not exist in the system.

message-not-found

A specified message does not exist in the system.

no-assigned-team

The authenticated user is not assigned to a team.

notification-not-found

A specified notification does not exist in the system.

overtime-rule-not-found

A specified overtime rule does not exist in the system.

pay-code-not-found

A specified pay code does not exist in the system.

pay-period-not-found

A specified pay period does not exist in the system.

policy-not-found

A specified policy does not exist in the system.

policy-relationship-not-found

A specified policy relationship does not exist in the system.

provider-not-found

A specified provider does not exist in the system.

punch-warnings-not-found

A specified punch warnings does not exist in the system.

query-result-not-found

A specified query result does not exist in the system.

rbac-role-not-found

A specified rbac role does not exist in the system.

recurring-schedule-not-found

A specified recurring schedule does not exist in the system.

report-not-found

A specified report does not exist in the system.

report-run-not-found

A specified report run does not exist in the system.

role-not-found

A specified role does not exist in the system.

rounding-rule-not-found

A specified rounding rule does not exist in the system.

sandbox-not-found

A specified sandbox does not exist in the system.

schedule-group-not-found

A specified schedule group does not exist in the system.

shift-not-found

A specified shift does not exist in the system.

shift-swap-application-not-found

A specified shift swap application does not exist in the system.

shift-swap-listing-not-found

A specified shift swap listing does not exist in the system.

skill-assignment-not-found

A specified skill assignment does not exist in the system.

skill-not-found

A specified skill does not exist in the system.

skill-requirement-template-not-found

A specified skill requirement template does not exist in the system.

team-not-found

A specified team does not exist in the system.

time-off-policy-not-found

A specified time off policy does not exist in the system.

time-off-request-not-found

A specified time off request does not exist in the system.

timecard-not-found

A specified timecard does not exist in the system.

timecard-punch-not-found

A specified timecard punch does not exist in the system.

user-not-found

A specified user does not exist in the system.

vacation-bid-not-found

A specified vacation bid does not exist in the system.

vacation-bid-period-not-found

A specified vacation bid period does not exist in the system.

webhook-not-found

A specified webhook does not exist in the system.

work-rule-not-found

A specified work rule does not exist in the system.

workflow-not-found

A specified workflow does not exist in the system.

workflow-run-not-found

A specified workflow run does not exist in the system.

409 Conflict#

availability-has-scheduled-shift

This availability overlaps a scheduled shift, so it cannot be changed. Contact your scheduler to change the shift first.

availability-imported

The availability was imported from a connected calendar and can only be changed there.

availability-locked

Availability for these dates is locked while a schedule is being drafted.

client-timezone-pinned

The company shows providers its own time zone, so a provider's time zone cannot be changed.

duplicate-help-path

A help collection or article already exists at the specified path.

Show extension members
fullPathstring
Required
duplicate-shift-template

A shift template with the same name already exists for this team.

duplicate-skill

A skill with the same name and type already exists.

duplicate-skill-collection

A skill collection with the same name already exists for this skill.

duplicate-skill-value

A value with the same name already exists for this skill.

email-in-use

The specified email address is already in use by another user.

policy-relationship-already-exists

One or more time off policies are already linked to another vacation bid.

sandbox-busy

The sandbox is being created, reset or deleted; try again once it is ready.

shift-already-claimed

The requested shift has already been claimed by another provider.

shift-already-started

The requested shift has already started and cannot be claimed.

shift-claim-window-closed

The requested shift cannot be claimed within the configured minimum notice window.

Show extension members
shiftIdstring
Required
minimumNoticeMinutesinteger· min 0
Required
startsAtstring
Required
shift-missing-skills

The requested shift requires skills the provider does not have.

Show extension members
shiftIdstring
Required
missingSkillsobject[]
Required
namestring
Required
valuestring
typeenum
Required
licensed_region
language
enrollment
custom
shift-schedule-conflict

The requested shift overlaps with an existing shift for this provider.

Show extension members
shiftIdstring
Required
conflictsobject[]
Required
idstring
Required
startDatestring
Required
endDatestring
Required
version-conflict

This object has been changed. Refresh to see the latest version.

Show extension members
idstring
Required
currentVersionnumber
Required

503 Service Unavailable#

maintenance-mode

The requested company is temporarily read-only.