Skip to main content
POST
Create custom requirement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
requirementType
enum<string>
required
Available options:
OFFBOARDING
title
string
required

Display title for the requirement.

instructions
string | null

Instructions for completing the requirement. Omit for none.

Response

201 - application/json

Custom requirement created

id
string
required

The custom requirement's unique ID.

title
string
required

The custom requirement's display title.

requirementType
enum<string>
required

Whether the requirement applies during onboarding or offboarding.

Available options:
ONBOARDING,
OFFBOARDING
ownerType
enum<string>
required

Who completes the requirement. Offboarding requirements are always completed by an admin.

Available options:
ADMIN,
EMPLOYEE
textInputLabel
string | null
required

Label for the requirement's text input, or null if it has none.

fileInputLabel
string | null
required

Label for the requirement's file input, or null if it has none.

instructions
string | null
required

Instructions for completing the requirement, or null if it has none.

createdAt
string<date-time>
required

The date the requirement was created.

updatedAt
string<date-time>
required

The date the requirement was last updated.