Skip to content

Rippling: Rest API schemas (part 2)

95 Rippling schemas with complete fields and constraints.

← Rest API operations · All schemas

Create a workflow — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
actionsarrayRequired within parentMaximum items: 160
Minimum items: 1
actions[]JSONEach item
actions[] (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / actions / item / kind: registered callback
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 3000
description (anyOf 2)nullAlternative
enabledbooleanOptionalDefault: false
namestringRequired within parentMaximum length: 150
Minimum length: 1
statusstringOptionalDefault: draft
One of: draft, published
triggerJSONRequired within parent
trigger (oneOf 1)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: annual schedule
trigger (oneOf 2)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: biweekly schedule
trigger (oneOf 3)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: business event
trigger (oneOf 4)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: cron schedule
trigger (oneOf 5)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years
trigger (oneOf 6)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: daily schedule
trigger (oneOf 7)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: inbound email
trigger (oneOf 8)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: manual
trigger (oneOf 9)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly on day of week schedule
trigger (oneOf 10)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: monthly schedule
trigger (oneOf 11)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: one time schedule
trigger (oneOf 12)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: quarterly schedule
trigger (oneOf 13)ModelAlternativeExpand Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack
trigger (oneOf 14)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekday schedule
trigger (oneOf 15)ModelAlternativeExpand Create a workflow — request body — body / trigger / kind: weekly schedule

Referenced models: Create a workflow — request body — body / trigger / kind: annual schedule, Create a workflow — request body — body / trigger / kind: biweekly schedule, Create a workflow — request body — body / trigger / kind: business event, Create a workflow — request body — body / trigger / kind: cron schedule, Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years, Create a workflow — request body — body / trigger / kind: daily schedule, Create a workflow — request body — body / trigger / kind: inbound email, Create a workflow — request body — body / trigger / kind: manual, Create a workflow — request body — body / trigger / kind: monthly on day of week schedule, Create a workflow — request body — body / trigger / kind: monthly schedule, Create a workflow — request body — body / trigger / kind: one time schedule, Create a workflow — request body — body / trigger / kind: quarterly schedule, Create a workflow — request body — body / actions / item / kind: registered callback, Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack, Create a workflow — request body — body / trigger / kind: weekday schedule, Create a workflow — request body — body / trigger / kind: weekly schedule

Create a workflow — request body — body / actions / item / kind: registered callback

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
idstringRequired within parentMinimum length: 1
implementation_configstringRequired within parentMinimum length: 1
kindstringRequired within parentOne of: registered_callback
owner_idstringRequired within parentMinimum length: 1
owner_typestringRequired within parentMinimum length: 1

Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
allowed_sender_group_idJSONOptional
allowed_sender_group_id (anyOf 1)stringAlternative
allowed_sender_group_id (anyOf 2)nullAlternative
channel_idsarrayRequired within parentMinimum items: 1
channel_ids[]stringEach item
event_typestringRequired within parentOne of: message_posted, reaction_added
include_thread_repliesbooleanOptionalDefault: false
kindstringRequired within parentOne of: slack
message_text_regexJSONOptional
message_text_regex (anyOf 1)stringAlternativeMaximum length: 512
message_text_regex (anyOf 2)nullAlternative
reaction_namesarrayOptional
reaction_names[]stringEach item

Create a workflow — request body — body / trigger / kind: annual schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthintegerRequired within parentMaximum: 31
Minimum: 1
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: annual_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
month_of_yearintegerRequired within parentMaximum: 12
Minimum: 1
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: biweekly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
days_of_weekarrayRequired within parent
days_of_week[]integerEach item
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: biweekly_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: business event

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
event_namestringRequired within parent
kindstringRequired within parentOne of: business_event

Create a workflow — request body — body / trigger / kind: cron schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
expressionstringRequired within parent
kindstringRequired within parentOne of: cron_schedule
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONOptional
day_of_month (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 2)nullAlternative
days_of_weekJSONOptional
days_of_week (anyOf 1)arrayAlternative
days_of_week (anyOf 1)[]integerEach item
days_of_week (anyOf 2)nullAlternative
hourintegerOptionalDefault: 0
Maximum: 23
Minimum: 0
intervalintegerRequired within parentMinimum: 1
kindstringRequired within parentOne of: custom_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
month_of_yearJSONOptional
month_of_year (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 2)nullAlternative
start_monthJSONOptional
start_month (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
start_month (anyOf 2)nullAlternative
timezonestringRequired within parent
unitstringRequired within parentOne of: minutes, hours, days, weeks, months, years

Create a workflow — request body — body / trigger / kind: daily schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: daily_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: inbound email

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
body_containsJSONOptional
body_contains (anyOf 1)stringAlternative
body_contains (anyOf 2)nullAlternative
has_attachmentbooleanOptionalDefault: false
kindstringRequired within parentOne of: inbound_email
recipient_emailstringRequired within parent
subject_containsJSONOptional
subject_contains (anyOf 1)stringAlternative
subject_contains (anyOf 2)nullAlternative

Create a workflow — request body — body / trigger / kind: manual

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentOne of: manual

Create a workflow — request body — body / trigger / kind: monthly on day of week schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_weekintegerRequired within parentMaximum: 6
Minimum: 0
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: monthly_on_day_of_week_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent
week_of_monthintegerRequired within parentMaximum: 4
Minimum: 1

Create a workflow — request body — body / trigger / kind: monthly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthintegerRequired within parentMaximum: 31
Minimum: 1
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: monthly_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: one time schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthintegerRequired within parentMaximum: 31
Minimum: 1
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: one_time_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
month_of_yearintegerRequired within parentMaximum: 12
Minimum: 1
timezonestringRequired within parent
yearintegerRequired within parentMaximum: 9999
Minimum: 1

Create a workflow — request body — body / trigger / kind: quarterly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthintegerRequired within parentMaximum: 31
Minimum: 1
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: quarterly_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
month_of_yearintegerRequired within parentMaximum: 12
Minimum: 1
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: weekday schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: weekday_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent

Create a workflow — request body — body / trigger / kind: weekly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
days_of_weekarrayRequired within parent
days_of_week[]integerEach item
hourintegerRequired within parentMaximum: 23
Minimum: 0
kindstringRequired within parentOne of: weekly_schedule
minuteintegerOptionalDefault: 0
Maximum: 59
Minimum: 0
timezonestringRequired within parent

Create a workflow — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
authoringModelRequired within parentExpand Create a workflow — response body — authoring
created_atstringRequired within parentFormat: date-time
definitionJSONRequired within parent
definition (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable
definition (anyOf 2)ModelAlternativeExpand Create a workflow — response body — definition / kind: read only
deletablebooleanRequired within parent
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
enabledbooleanRequired within parent
has_draftbooleanRequired within parent
idstringRequired within parent
namestringRequired within parent
owner_idstringRequired within parent
statusstringRequired within parentKnown values: draft, published, unknown
updated_atstringRequired within parentFormat: date-time
version_idstringRequired within parent

Referenced models: Create a workflow — response body — definition / kind: editable, Create a workflow — response body — definition / kind: read only, Create a workflow — response body — authoring

Create a workflow — response body — authoring

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
modestringRequired within parentKnown values: full, metadata_only, read_only
patchable_fieldsarrayRequired within parent
patchable_fields[]stringEach itemKnown values: name, description, status, enabled, trigger, actions
reason_codesarrayRequired within parent
reason_codes[]stringEach itemKnown values: unsupported_trigger, unsupported_graph, insufficient_permission, missing_current_version

Create a workflow — response body — definition / kind: editable

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
actionsarrayRequired within parentMaximum items: 160
Minimum items: 1
actions[]JSONEach item
actions[] (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable actions item kind: registered callback
kindstringRequired within parentKnown values: editable
triggerJSONRequired within parent
trigger (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: daily schedule
trigger (anyOf 2)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: business event
trigger (anyOf 3)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule
trigger (anyOf 4)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule
trigger (anyOf 5)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule
trigger (anyOf 6)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule
trigger (anyOf 7)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule
trigger (anyOf 8)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule
trigger (anyOf 9)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: annual schedule
trigger (anyOf 10)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: one time schedule
trigger (anyOf 11)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years
trigger (anyOf 12)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: cron schedule
trigger (anyOf 13)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: manual
trigger (anyOf 14)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack
trigger (anyOf 15)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: inbound email

Referenced models: Create a workflow — response body — definition / kind: editable trigger kind: annual schedule, Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule, Create a workflow — response body — definition / kind: editable trigger kind: business event, Create a workflow — response body — definition / kind: editable trigger kind: cron schedule, Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years, Create a workflow — response body — definition / kind: editable trigger kind: daily schedule, Create a workflow — response body — definition / kind: editable trigger kind: inbound email, Create a workflow — response body — definition / kind: editable trigger kind: manual, Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule, Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule, Create a workflow — response body — definition / kind: editable trigger kind: one time schedule, Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule, Create a workflow — response body — definition / kind: editable actions item kind: registered callback, Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack, Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule, Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule

Create a workflow — response body — definition / kind: editable actions item kind: registered callback

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
idstringRequired within parentMinimum length: 1
implementation_configstringRequired within parentMinimum length: 1
kindstringRequired within parentKnown values: registered_callback
owner_idstringRequired within parentMinimum length: 1
owner_typestringRequired within parentMinimum length: 1

Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
allowed_sender_group_idJSONOptional
allowed_sender_group_id (anyOf 1)stringAlternative
allowed_sender_group_id (anyOf 2)nullAlternative
channel_idsarrayRequired within parentMinimum items: 1
channel_ids[]stringEach item
event_typestringRequired within parentKnown values: message_posted, reaction_added
include_thread_repliesbooleanOptionalDefault: false
kindstringRequired within parentKnown values: slack
message_text_regexJSONOptional
message_text_regex (anyOf 1)stringAlternativeMaximum length: 512
message_text_regex (anyOf 2)nullAlternative
reaction_namesarrayOptional
reaction_names[]stringEach item

Create a workflow — response body — definition / kind: editable trigger kind: annual schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONRequired within parent
day_of_month (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: annual_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_yearJSONRequired within parent
month_of_year (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
days_of_weekarrayRequired within parent
days_of_week[]JSONEach item
days_of_week[] (anyOf 1)integerAlternative
days_of_week[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: biweekly_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: business event

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
event_namestringRequired within parent
kindstringRequired within parentKnown values: business_event

Create a workflow — response body — definition / kind: editable trigger kind: cron schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
expressionstringRequired within parent
kindstringRequired within parentKnown values: cron_schedule
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONOptional
day_of_month (anyOf 1)JSONAlternative
day_of_month (anyOf 1) (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
day_of_month (anyOf 2)nullAlternative
days_of_weekJSONOptional
days_of_week (anyOf 1)arrayAlternative
days_of_week (anyOf 1)[]JSONEach item
days_of_week (anyOf 1)[] (anyOf 1)integerAlternative
days_of_week (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
days_of_week (anyOf 2)nullAlternative
hourJSONOptional
hour (anyOf 1)integerAlternativeDefault: 0
Maximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalJSONRequired within parent
interval (anyOf 1)integerAlternativeMinimum: 1
interval (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: custom_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_yearJSONOptional
month_of_year (anyOf 1)JSONAlternative
month_of_year (anyOf 1) (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_year (anyOf 2)nullAlternative
start_monthJSONOptional
start_month (anyOf 1)JSONAlternative
start_month (anyOf 1) (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
start_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_month (anyOf 2)nullAlternative
timezonestringRequired within parent
unitstringRequired within parentKnown values: minutes, hours, days, weeks, months, years

Create a workflow — response body — definition / kind: editable trigger kind: daily schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: daily_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: inbound email

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
body_containsJSONOptional
body_contains (anyOf 1)stringAlternative
body_contains (anyOf 2)nullAlternative
has_attachmentbooleanOptionalDefault: false
kindstringRequired within parentKnown values: inbound_email
recipient_emailstringRequired within parent
subject_containsJSONOptional
subject_contains (anyOf 1)stringAlternative
subject_contains (anyOf 2)nullAlternative

Create a workflow — response body — definition / kind: editable trigger kind: manual

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentKnown values: manual

Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_weekJSONRequired within parent
day_of_week (anyOf 1)integerAlternativeMaximum: 6
Minimum: 0
day_of_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: monthly_on_day_of_week_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent
week_of_monthJSONRequired within parent
week_of_month (anyOf 1)integerAlternativeMaximum: 4
Minimum: 1
week_of_month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONRequired within parent
day_of_month (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: monthly_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: one time schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONRequired within parent
day_of_month (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: one_time_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_yearJSONRequired within parent
month_of_year (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent
yearJSONRequired within parent
year (anyOf 1)integerAlternativeMaximum: 9999
Minimum: 1
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
day_of_monthJSONRequired within parent
day_of_month (anyOf 1)integerAlternativeMaximum: 31
Minimum: 1
day_of_month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: quarterly_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
month_of_yearJSONRequired within parent
month_of_year (anyOf 1)integerAlternativeMaximum: 12
Minimum: 1
month_of_year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: weekday_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
days_of_weekarrayRequired within parent
days_of_week[]JSONEach item
days_of_week[] (anyOf 1)integerAlternative
days_of_week[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONRequired within parent
hour (anyOf 1)integerAlternativeMaximum: 23
Minimum: 0
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
kindstringRequired within parentKnown values: weekly_schedule
minuteJSONOptional
minute (anyOf 1)integerAlternativeDefault: 0
Maximum: 59
Minimum: 0
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timezonestringRequired within parent

Create a workflow — response body — definition / kind: read only

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentKnown values: read_only
stepsarrayRequired within parent
steps[]ModelEach itemExpand Create a workflow — response body — definition / kind: read only steps item
triggerModelRequired within parentExpand Create a workflow — response body — definition / kind: read only trigger

Referenced models: Create a workflow — response body — definition / kind: read only steps item, Create a workflow — response body — definition / kind: read only trigger

Create a workflow — response body — definition / kind: read only steps item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
idstringRequired within parent
kindstringRequired within parentKnown values: read_only
namestringRequired within parent
next_idsarrayRequired within parent
next_ids[]stringEach item
source_typestringRequired within parentKnown values: action, fork, loop, switch, group, unknown

Create a workflow — response body — definition / kind: read only trigger

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentKnown values: read_only
source_typestringRequired within parentKnown values: business_event, record_change, scheduled, manual, webhook, date_relative, integration, unknown
summarystringRequired within parent

Create an agent session — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
agent_idstringRequired within parentThe ID of the agent to run
promptstringRequired within parentThe prompt to send to the agent
session_resume_stateobjectOptionalOptional opaque state used to restore the new session
session_resume_state.artifactstringRequired within parentAn opaque base64-encoded agent session resume state

Create an agent source revision — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
entrypointstringRequired within parentThe entrypoint file
filesarrayRequired within parentThe files in the source revision
files[]ModelEach itemExpand Create an agent source revision — response body — files item

Referenced models: Create an agent source revision — response body — files item

Create an agent source revision — response body — files item

FieldTypePresenceDescription and constraints
$objectRoot
contentstringRequired within parentThe contents of the source file
kindstringRequired within parentThe source file language or format
pathstringRequired within parentThe path of the source file

Create bulk draft hire — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
draft_hiresarrayRequired within parentList of draft hires
draft_hires[]ModelEach itemExpand Create bulk draft hire — request body — body draft hires item

Referenced models: Create bulk draft hire — request body — body draft hires item

Create bulk draft hire — request body — body draft hires item

FieldTypePresenceDescription and constraints
$objectRoot
A draft hire represents a candidate who has been offered a position but hasn't started yet.

This class provides Platform API access to draft hire data stored as RoleWithCompany instances
in a candidate state, allowing external systems to create and manage draft hires.
custom_fieldsarrayOptionalCustom fields for the draft hire
custom_fields[]ModelEach itemExpand Create bulk draft hire — request body — body draft hires item custom fields item
documentsarrayOptionalDocuments to attach to this draft hire
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
employment_infoobjectRequired within parentEmployment information for the draft hire position
employment_info.contract_end_datestringOptionalContract end date
employment_info.currencystringOptionalCurrency
employment_info.department_idstringOptionalDepartment ID
employment_info.dutiesstringOptionalDuties
employment_info.eeoc_job_classificationstringOptionalEEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS, SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS, SERVICE_WORKERS)
employment_info.employment_type_idstringRequired within parentEmployment type ID
employment_info.equity_num_sharesintegerOptionalEquity number of shares
employment_info.equity_valuenumberOptionalEquity value
employment_info.equity_vesting_scheduleModelOptionalExpand Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule
employment_info.job_family_idstringOptionalJob family ID
employment_info.job_titlestringOptionalJob title
employment_info.legal_entity_idstringOptionalLegal entity ID
employment_info.level_idstringOptionalLevel ID
employment_info.manager_idstringOptionalManager ID
employment_info.offer_expiration_datestringOptionalOffer expiration date
employment_info.on_target_commissionnumberOptionalOn target commission
employment_info.overtime_exemptionstringOptionalOvertime exemption
One of: exempt, non-exempt
employment_info.probation_end_datestringOptionalProbation end date
employment_info.relocation_reimbursementnumberOptionalRelocation reimbursement
employment_info.salary_per_unitnumberOptionalSalary per unit
employment_info.salary_unitstringOptionalSalary unit
employment_info.signing_bonusnumberOptionalSigning bonus
employment_info.start_datestringOptionalStart date
employment_info.target_annual_bonusnumberOptionalTarget annual bonus
employment_info.target_annual_bonus_percentnumberOptionalTarget annual bonus as a percentage
employment_info.teams_idsarrayOptionalTeams IDs
employment_info.teams_ids[]stringEach item
employment_info.titlestringRequired within parentTitle
employment_info.weekly_hoursnumberOptionalWeekly hours
employment_info.work_emailstringOptionalWork email
headcount_infoobjectOptionalHeadcount planning info for hiring into a position. If provided, the draft hire will be linked to the specified open headcount allocation. Requires headcount planning to be enabled for the company.
headcount_info.position_idstringRequired within parentThe Position ID (PID) of the headcount allocation to fill (e.g., PID100615)
personal_infoobjectRequired within parentPersonal information for the draft hire candidate
personal_info.citizenshipstringOptionalCitizenship of the candidate
personal_info.date_of_birthstringOptionalDate of birth
personal_info.emergency_contact_namestringOptionalEmergency contact name
personal_info.emergency_contact_phoneModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info emergency contact phone
personal_info.ethnicitystringOptionalEthnicity of the candidate
personal_info.genderstringOptionalGender of the candidate
personal_info.home_addressModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info home address
personal_info.invite_emailstringRequired within parentInvite email of the candidate
personal_info.localeModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info locale
personal_info.nameModelRequired within parentExpand Create bulk draft hire — request body — body draft hires item personal info name
personal_info.personal_phoneModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info personal phone
personal_info.racestringOptionalRace of the candidate
personal_info.ssnstringOptionalSocial security number of the candidate
work_location_infoobjectRequired within parentWork location information
work_location_info.country_codestringOptionalCountry code of the work location
work_location_info.is_remotebooleanOptionalWhether the work location is remote
work_location_info.location_idstringOptionalWork location ID
work_location_info.state_codestringOptionalState code of the work location

Referenced models: Create a new employee document — response body — items item documents item, Create bulk draft hire — request body — body draft hires item personal info home address, Create bulk draft hire — request body — body draft hires item custom fields item, Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule, Create bulk draft hire — request body — body draft hires item personal info locale, Create bulk draft hire — request body — body draft hires item personal info name, Create bulk draft hire — request body — body draft hires item personal info personal phone, Create bulk draft hire — request body — body draft hires item personal info emergency contact phone

Create bulk draft hire — request body — body draft hires item custom fields item

FieldTypePresenceDescription and constraints
$objectRootCustom field information for a draft hire.

Custom fields are associated with RoleWithCompany model.
field_namestringRequired within parentName of the custom field
field_valueobjectRequired within parentValue of the custom field

Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule

FieldTypePresenceDescription and constraints
$objectRootEquity vesting schedule
_namestringOptionalName of the vesting schedule
cliffMonthsintegerOptionalNumber of cliff months before vesting begins
company_idstringRequired within parentRequired company ID for the vesting schedule
continuousVestingMonthsintegerOptionalNumber of continuous vesting months
percentageInitialVestingnumberOptionalPercentage of initial vesting as decimal
Format: decimal
spokeIdstringOptionalSpoke ID for the vesting schedule
totalVestingMonthsintegerOptionalTotal number of vesting months
totalVestingYearsintegerOptionalTotal number of vesting years
vestingTypestringOptionalType of vesting schedule

Create bulk draft hire — request body — body draft hires item personal info emergency contact phone

FieldTypePresenceDescription and constraints
$objectRootEmergency contact phone
country_codestringOptionalCountry code for the phone number
extensionstringOptionalPhone number extension
national_numberstringOptionalNational phone number without country code

Create bulk draft hire — request body — body draft hires item personal info home address

FieldTypePresenceDescription and constraints
$objectRoot
countrystringOptionalThe country component, pursuant to SCIM RFC 7643 4.1.2.
One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
formattedstringOptionalThe formatted mailing address.
localitystringOptionalThe city or locality component.
postal_codestringOptionalThe zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
regionstringOptionalThe state or region component, pursuant to SCIM RFC 7643 4.1.2.
street_addressstringOptionalThe full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
typestringOptionalThe classification of the address.
One of: HOME, WORK, OTHER

Create bulk draft hire — request body — body draft hires item personal info locale

FieldTypePresenceDescription and constraints
$objectRootLocale of the candidate
language_codestringOptionalThe primary language code
language_inspectionarrayOptionalAdditional language inspection data
language_inspection[]stringEach item
locale_codestringOptionalThe locale code for formatting
region_codestringOptionalThe region code
timezonestringOptionalThe user's timezone

Create bulk draft hire — request body — body draft hires item personal info name

FieldTypePresenceDescription and constraints
$objectRootName of the candidate
firststringOptionalFirst name or given name
laststringOptionalLast name or family name
middlestringOptionalMiddle name(s)
nicknamestringOptionalPreferred nickname or informal name
suffixstringOptionalName suffix (e.g., Jr., Sr., III)
titlestringOptionalTitle or honorific (e.g., Mr., Ms., Dr.)

Create bulk draft hire — request body — body draft hires item personal info personal phone

FieldTypePresenceDescription and constraints
$objectRootPersonal phone number
country_codestringOptionalCountry code for the phone number
extensionstringOptionalPhone number extension
national_numberstringOptionalNational phone number without country code

Create bulk draft hire — response body — invalid items item

FieldTypePresenceDescription and constraints
$objectRootResult for an individual draft hire creation.
draft_hire_role_idstringOptionalGenerated draft hire ID if successful
errorsarrayOptionalList of validation errors if any
errors[]stringEach item
messagestringOptionalSuccess or error message
statusstringRequired within parentStatus of the creation (success, error, warning)

Create hire — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
hiresarrayRequired within parentOne to five hire submissions. Results are returned in the same order.
hires[]ModelEach itemExpand Create hire — request body — body hires item

Referenced models: Create hire — request body — body hires item

Create hire — request body — body hires item

FieldTypePresenceDescription and constraints
$objectRootOne hire on POST /hires/. Country-specific employment fields come from GET /hire-requirements/.
Additional keys: not allowed
client_request_idstringOptionalOptional id echoed on that hire's result. Not a hire field.
compensationobjectOptionalBase pay and any additional compensation offered for this job. Monetary values contain an ISO 4217 currency code and decimal amount.
Additional keys: not allowed
compensation.base_pay_amountModelOptionalExpand Create hire — request body — body hires item compensation base pay amount
compensation.base_pay_periodstringOptionalUnit of time represented by base_pay_amount: YEAR, MONTH, WEEK, DAY, or HOUR. For example, an annual salary uses YEAR and an hourly rate uses HOUR. Starting with API version 2025-08-01, contractor PAY_AS_YOU_GO compensation requires HOUR, MILESTONE requires YEAR, and FIXED accepts any listed unit.
One of: YEAR, MONTH, WEEK, DAY, HOUR
compensation.car_allowanceobjectOptionalMexico direct hire car allowance. Provide only when listed by GET /hire-requirements/ for the selected country and hire type. currency_type, such as MXN, must match compensation.base_pay_amount.currency_type.
compensation.car_allowance.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
compensation.car_allowance.valuenumberOptionalThe decimal amount for the currency.
compensation.christmas_bonus_daysintegerOptionalMexico Christmas bonus in days, from 15 to 30. Required for Mexico EOR. For direct hire, provide only when listed by GET /hire-requirements/ for the selected country and hire type.
compensation.commissionModelOptionalExpand Create hire — request body — body hires item compensation commission
compensation.equityModelOptionalExpand Create hire — request body — body hires item compensation equity
compensation.grocery_couponobjectOptionalMexico direct hire grocery coupon. Provide only when listed by GET /hire-requirements/ for the selected country and hire type. currency_type, such as MXN, must match compensation.base_pay_amount.currency_type.
compensation.grocery_coupon.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
compensation.grocery_coupon.valuenumberOptionalThe decimal amount for the currency.
compensation.relocationModelOptionalExpand Create hire — request body — body hires item compensation relocation
compensation.relocation_expenseobjectOptionalMexico direct hire relocation expense. Provide only when listed by GET /hire-requirements/ for the selected country and hire type. This is not compensation.relocation. currency_type, such as MXN, must match compensation.base_pay_amount.currency_type.
compensation.relocation_expense.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
compensation.relocation_expense.valuenumberOptionalThe decimal amount for the currency.
compensation.remote_working_allowanceModelOptionalExpand Create hire — request body — body hires item compensation remote working allowance
compensation.savings_fund_percentstringOptionalMexico direct hire savings fund percent as a numeric string without the percent sign, such as 10. Allowed range is 0 to 100. Provide only when listed by GET /hire-requirements/ for the selected country and hire type.
compensation.signing_bonusModelOptionalExpand Create hire — request body — body hires item compensation signing bonus
compensation.target_bonusModelOptionalExpand Create hire — request body — body hires item compensation target bonus
compensation.telecom_allowanceobjectOptionalMexico direct hire telecommunications and electricity allowance. Required for every Mexico direct hire. currency_type, such as MXN, must match compensation.base_pay_amount.currency_type.
compensation.telecom_allowance.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
compensation.telecom_allowance.valuenumberOptionalThe decimal amount for the currency.
compensation.thirteenth_month_bonusobjectOptionalContractually required thirteenth-month salary payment. Provide only when listed by GET /hire-requirements/ for the selected country and hire type.
compensation.thirteenth_month_bonus.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
compensation.thirteenth_month_bonus.valuenumberOptionalThe decimal amount for the currency.
compensation.vacation_premium_percentstringOptionalMexico vacation premium percent as a numeric string without the percent sign, such as 25. Required for Mexico EOR and must be 25. For direct hire, provide only when listed by GET /hire-requirements/ for the selected country and hire type; allowed range is 25 to 100. Omitting it does not apply a default.
custom_fieldsarrayOptionalValues for company-configured custom fields collected during hiring. Use each field's configured ID and value shape; omit this array when no custom hiring fields are being supplied.
custom_fields[]ModelEach itemExpand Create hire — request body — body hires item custom fields item
employmentobjectRequired within parentThe job: title, hours, and country-specific details.
Additional keys: not allowed
employment.authorized_to_workbooleanOptionalWhether the person is legally authorized to work in the work_location country. Provide only when listed by GET /hire-requirements/; true confirms authorization and false may make the hire ineligible.
employment.collective_bargainingModelOptionalExpand Create hire — request body — body hires item employment collective bargaining
employment.company_equipmentstringOptionalMexico EOR. Free-text description of equipment the company assigns. Optional.
employment.company_uses_digital_currencybooleanOptionalWhether the hiring company conducts business involving cryptocurrency or another digital currency. Required for China EOR hires. A true value may make the hire ineligible for the selected EOR service.
employment.contractModelOptionalExpand Create hire — request body — body hires item employment contract
employment.contractor_paying_entity_typestringOptionalCOMPANY_OWN_ENTITY hires the contractor on the company's own legal entity. Send that entity in employment.legal_entity_id. Send this when the company is fully migrated to Global Payroll and the work location is in a Contractor of Record state. Omit for non-contractor hires. When the hiring flow requires it and it is omitted, the hire stays incomplete.
One of: COMPANY_OWN_ENTITY
employment.daily_salary_basisstringOptionalMexico direct hire. THIRTY_DAYS divides monthly pay by 30. THIRTY_POINT_FOUR_DAYS divides monthly pay by 30.4. Required when the selected legal entity uses Rippling Global Payroll; otherwise optional. Check the entity's Global Payroll settings in Rippling.
One of: THIRTY_DAYS, THIRTY_POINT_FOUR_DAYS
employment.department_idstringOptionalDepartment id from GET /departments/.
employment.dutiesstringOptionalPlain-text summary of the role's primary responsibilities and day-to-day work.
employment.employment_modelstringOptionalEmployment model for a Germany EOR hire. Use AUG for employee leasing or CONSULTANT for a remote consultant engagement. CONSULTANT is valid only when work_location.is_remote is true.
One of: AUG, CONSULTANT
employment.employment_type_idstringRequired within parentEmployment type id from GET /employment-types/. Starting with API version 2025-08-01, a contractor employment type changes which fields are required or ignored. Call GET /hire-requirements/ for the applicable rules.
employment.engagementobjectOptionalProfessional field and consulting-project details required by the hire context.
Additional keys: not allowed
employment.engagement.consulting_project_descriptionstringRequired within parentDescription of the client project and the work the worker will perform.
employment.engagement.field_of_workstringRequired within parentProfessional field in which the worker will perform the engagement.
employment.eor_costs_acknowledgedbooleanOptionalConfirms that the caller has reviewed and accepts the estimated EOR costs and applicable Rippling EOR terms for this hire. Required for EOR hires and must be true; false means the hire cannot proceed. See https://help.rippling.com/s/article/850659217136 and https://app.rippling.com/legal/eor.
employment.eor_eligibility_terms_acknowledgedbooleanOptionalConfirms that the caller has reviewed and accepts Rippling's EOR eligibility conditions for this proposed hire, including the EOR screenout guidance. Required for EOR hires and must be true; false means the hire cannot proceed. See https://help.rippling.com/s/article/757822852718.
employment.framework_agreementModelOptionalExpand Create hire — request body — body hires item employment framework agreement
employment.french_occupation_classification_codestringOptionalFrench Professions et Catégories Socioprofessionnelles (PCS) code that classifies the occupation performed by this role, such as 100X. Use a code allowed by GET /hire-requirements/.
employment.hired_due_to_mergerbooleanOptionalRequired for GB and IE EOR. True if this hire is from a merger or acquisition.
employment.is_eor_transferbooleanOptionalWhether the worker's employment is transferring from another employer-of-record provider. Send true for an EOR-to-EOR transfer and false when this is not an EOR transfer. Required for EOR hires outside the United States.
employment.is_shift_workerbooleanOptionalWhether the role is legally or contractually classified as shift work, rather than merely having hours outside a typical workday. Send true when the applicable employment terms designate the worker as a shift worker; send false when they do not. Required only when listed by GET /hire-requirements/.
employment.is_technology_focused_rolebooleanOptionalWhether the role's primary work is technology-focused. Required for China EOR hires when social_contribution_city is SHANGHAI or BEIJING; omit it for other cities.
employment.job_classificationstringOptionalUS EEO-1 job category for the role. Use a value returned by GET /hire-requirements/. Omit for contractor hires.
employment.job_function_idstringOptionalJob function that categorizes the type of work performed by this role. Send an id returned by GET /job-functions/.
employment.legal_entity_idstringOptionalSend a candidate entity id from GET /company-legal-entities/. Required for direct_hire; omit for eor. Rippling validates that the selected entity belongs to the company and supports the requested hire.
employment.level_idstringOptionalJob level for the role within the company's job architecture. Send an id returned by GET /levels/.
employment.manager_idstringOptionalManager worker id from GET /workers/. Omit or null for no manager.
employment.meets_eor_eligibility_criteriabooleanOptionalConfirms that the proposed hire satisfies Rippling's country-specific EOR eligibility screening criteria. Required for Hong Kong, Switzerland, and New Zealand EOR hires and must be true. Rippling maps this assertion to the applicable country-specific screening response. See https://help.rippling.com/s/article/757822852718.
employment.modern_awardModelOptionalExpand Create hire — request body — body hires item employment modern award
employment.non_competebooleanOptionalWhether the proposed employment terms include a non-compete restriction. Provide only when listed by GET /hire-requirements/.
employment.noticeModelOptionalExpand Create hire — request body — body hires item employment notice
employment.overtime_classificationstringOptionalThe role's overtime classification under applicable employment law. EXEMPT means overtime requirements do not apply; NON_EXEMPT means the worker may be entitled to overtime pay. Omit for contractor hires.
One of: EXEMPT, NON_EXEMPT
employment.owns_entity_in_countrybooleanOptionalWhether the hiring company owns a legal entity in the worker's country. Required only when listed by GET /hire-requirements/; for Netherlands EOR hires, this answer determines the applicable hiring path.
employment.paid_in_foreign_currencybooleanOptionalMexico EOR. True when pay is in a currency other than Mexican pesos. Optional. Omitting this uses false.
employment.paid_sick_daysintegerOptionalAnnual company-provided paid sick-day allowance, excluding any separate statutory entitlement. Provide only when listed by GET /hire-requirements/.
employment.position_of_trustbooleanOptionalRequired for Mexico direct hire and EOR. True when this person is a manager or director in a position of trust; otherwise false.
employment.probationModelOptionalExpand Create hire — request body — body hires item employment probation
employment.receives_tipsbooleanOptionalWhether the worker is expected to receive tips as part of this job. Omit for contractor hires.
employment.regular_working_hoursModelOptionalExpand Create hire — request body — body hires item employment regular working hours
employment.requires_trainingbooleanOptionalWhether the employment terms require the worker to complete training for this role. For Spanish direct hires, send true when training is required and false when it is not.
employment.salary_compositionstringOptionalMexico direct hire pay mix. FIXED is salary only. MIXED is salary plus bonus. VARIABLE is a small base salary and a larger bonus. Required when the selected legal entity uses Rippling Global Payroll; otherwise optional. Check the entity's Global Payroll settings in Rippling.
One of: FIXED, MIXED, VARIABLE
employment.schedule_typestringOptionalThe role's recurring schedule pattern: FIXED_SCHEDULE for a consistent schedule or ROTATING_SHIFT_SCHEDULE for shifts that rotate. Provide only when listed by GET /hire-requirements/.
One of: FIXED_SCHEDULE, ROTATING_SHIFT_SCHEDULE
employment.soc_codestringOptionalUS Standard Occupational Classification code for the job, such as 15-1252. Omit for contractor hires.
employment.social_contribution_citystringOptionalChinese city whose local social-insurance and statutory contribution rules apply to the worker, such as SHANGHAI or BEIJING. Required for China EOR hires. Use a value returned by GET /hire-requirements/.
employment.start_datestringOptionalStart date in YYYY-MM-DD format.
employment.statutory_contract_classificationstringOptionalCountry-specific statutory contract code. For Spain, use an allowed value returned by GET /hire-requirements/ that is compatible with contract.type and employment_type_id.
employment.statutory_job_classificationstringOptionalStatutory employment classification for the role. For Germany, choose the applicable value returned by GET /hire-requirements/, such as EMPLOYEE, APPRENTICE, WORKING_STUDENT, INTERN, MARGINALLY_EMPLOYED, SHORT_TERM_WORK, or MANAGING_DIRECTOR. Rippling derives the internal classification workflow from this value.
employment.supporting_documentsobjectOptionalEmployment documents required to prepare the hire.
Additional keys: not allowed
employment.supporting_documents.resume_file_idstringOptionalId of the confirmed company-owned PDF or Word resume uploaded through POST /files/.
employment.supporting_documents.variable_compensation_plan_file_idstringOptionalId of the confirmed company-owned PDF or Word variable-compensation plan.
employment.team_idsarrayOptionalTeams the worker should belong to. Send team ids returned by GET /teams/. Omit for no team assignments.
employment.team_ids[]stringEach item
employment.titlestringRequired within parentJob title.
employment.use_default_tenurebooleanOptionalSet to true to start tenure on the start date. False keeps a prior tenure date unset.
employment.vacationModelOptionalExpand Create hire — request body — body hires item employment vacation
employment.vacation_rollover_daysintegerOptionalMaximum unused vacation days the worker may carry into the next leave year. Provide only when listed by GET /hire-requirements/.
employment.weekly_hoursstringOptionalExpected working hours per week. Supports whole or fractional hours, such as 40 or 37.5. Rippling derives any internal weekly-hours classification from this value. Omit for contractor hires.
employment.work_emailstringOptionalWork email for the hire.
employment.work_email_requiredbooleanOptionalSet to false to skip work-email assignment for this hire, including generation by company policy. Do not combine false with a nonempty employment.work_email. Set to true to enable the normal work-email flow. For a newly created hire, true, omission, and null have the same behavior. Omission or null preserves any saved work-email preference. If related_records.existing_role_id identifies a hire that has already moved beyond creation, an explicit true or false can return that hire as incomplete with a validation error.
employment.work_shiftstringOptionalRequired for Mexico direct hire. DAY_SHIFT_48_HOURS, NIGHT_SHIFT_42_HOURS, or DAY_SHIFT_45_HOURS.
One of: DAY_SHIFT_48_HOURS, NIGHT_SHIFT_42_HOURS, DAY_SHIFT_45_HOURS
employment.worker_qualificationstringOptionalWorker's professional qualification for a Switzerland EOR role, such as Engineer. This is plain text, not a Rippling resource identifier. Provide it only when GET /hire-requirements/ lists worker_qualification for the selected country and hire type.
employment.working_hours_arrangementstringOptionalWorking-hours system that legally applies to a China EOR role. Use STANDARD_WORKING_HOURS for a role governed by the standard daily and weekly limits, or FLEXIBLE_WORKING_HOURS when an approved flexible-hours system applies. Required for China EOR hires.
One of: STANDARD_WORKING_HOURS, FLEXIBLE_WORKING_HOURS
employment.works_in_construction_industrybooleanOptionalWhether the worker will perform work in Germany's construction industry. Required for Germany EOR hires. Rippling EOR does not currently support these roles, so true makes the hire ineligible.
hire_typestringOptionalEmployment model for this hire: direct_hire employs the person through the company's own legal entity; eor employs the person through Rippling's employer-of-record service. Defaults to direct_hire when omitted.
personalobjectOptionalThe person's legal name and the email address or mobile number used to send their invitation.
Additional keys: not allowed
personal.first_namestringOptionalPerson's legal given name as it should appear on employment and payroll records.
personal.invite_emailstringOptionalEmail address where the person should receive their Rippling invitation. At least one of invite_email or invite_phone is required; both may be provided.
personal.invite_phonestringOptionalMobile number where the person should receive their Rippling invitation, in international format including the country calling code, for example +14155550123. At least one of invite_email or invite_phone is required; both may be provided.
personal.last_namestringOptionalPerson's legal family name as it should appear on employment and payroll records.
personal.nationality_codestringOptionalPerson's nationality as an ISO 3166-1 alpha-2 country code, such as FR for French nationality. Provide it only when listed by GET /hire-requirements/. This is not the country where the person works.
related_recordsModelOptionalExpand Create hire — request body — body hires item related records
work_locationModelRequired within parentExpand Create hire — request body — body hires item work location

Referenced models: Create hire — request body — body hires item custom fields item, Create hire — request body — body hires item compensation base pay amount, Create hire — request body — body hires item employment collective bargaining, Create hire — request body — body hires item compensation commission, Create hire — request body — body hires item employment contract, Create hire — request body — body hires item compensation equity, Create hire — request body — body hires item employment framework agreement, Create hire — request body — body hires item employment modern award, Create hire — request body — body hires item employment notice, Create hire — request body — body hires item employment probation, Create hire — request body — body hires item employment regular working hours, Create hire — request body — body hires item related records, Create hire — request body — body hires item compensation relocation, Create hire — request body — body hires item compensation remote working allowance, Create hire — request body — body hires item compensation signing bonus, Create hire — request body — body hires item compensation target bonus, Create hire — request body — body hires item employment vacation, Create hire — request body — body hires item work location

Create hire — request body — body hires item compensation base pay amount

FieldTypePresenceDescription and constraints
$objectRootGross base-pay rate for one base_pay_period, before bonuses, commission, equity, or allowances. Provide currency_type as a three-letter ISO 4217 code and value as a nonnegative decimal amount. Use zero when the hire has no base pay, including supported zero-pay contractor arrangements.
currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
valuenumberOptionalThe decimal amount for the currency.

Create hire — request body — body hires item compensation commission

FieldTypePresenceDescription and constraints
$objectRootVariable sales compensation expected when the person meets target. on_target_amount is required; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.
Additional keys: not allowed
on_target_amountobjectRequired within parentExpected total commission for a full year when the person meets target, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.
on_target_amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
on_target_amount.valuenumberOptionalThe decimal amount for the currency.
payment_frequencystringOptionalHow often commission is paid: MONTH, QUARTER, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type.
One of: MONTH, QUARTER, YEAR

Create hire — request body — body hires item compensation equity

FieldTypePresenceDescription and constraints
$objectRootEquity grant offered with the job. amount is the grant's monetary value; num_shares and frequency provide additional grant terms when known. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.
Additional keys: not allowed
amountobjectRequired within parentMonetary value assigned to the equity grant, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valuenumberOptionalThe decimal amount for the currency.
frequencystringOptionalGrant frequency when applicable: ONE_TIME or ANNUAL.
One of: ONE_TIME, ANNUAL
num_sharesintegerOptionalNumber of shares or units included in the grant, when the grant is expressed in shares.

Create hire — request body — body hires item compensation relocation

FieldTypePresenceDescription and constraints
$objectRootOne-time relocation reimbursement or benefit offered for this hire. amount is required when the object is provided. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields. Mexico direct hire rejects this field; use relocation_expense instead. Mexico EOR accepts it only when the company's EOR compensation types include RELOCATION_BONUS and the relocation feature is enabled for that company and Mexico. No Platform API read exposes this company-specific eligibility; check the company's Mexico EOR compensation settings in Rippling before sending. If unavailable, the hire item fails with invalid_request before creation.
Additional keys: not allowed
amountobjectRequired within parentTotal relocation reimbursement or benefit, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valuenumberOptionalThe decimal amount for the currency.

Create hire — request body — body hires item compensation remote working allowance

FieldTypePresenceDescription and constraints
$objectRootRecurring allowance paid for remote-work expenses. Provide only when listed by GET /hire-requirements/ for the selected country and hire type; use a zero amount when the catalog requires the field but no allowance is offered. Switzerland maps this to the Swiss remote-working allowance. Mexico maps this to the Mexico remote work allowance: direct hire sends it when selected. Mexico EOR sets it automatically and rejects a caller-supplied value.
currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
valuenumberOptionalThe decimal amount for the currency.

Create hire — request body — body hires item compensation signing bonus

FieldTypePresenceDescription and constraints
$objectRootOne-time payment offered for accepting or starting the job. When provided, amount and schedule are required; payment_days is optional. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.
Additional keys: not allowed
amountobjectRequired within parentTotal one-time signing bonus, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valuenumberOptionalThe decimal amount for the currency.
payment_daysintegerOptionalNumber of days after the applicable start or schedule event when the bonus is paid, if used.
schedulestringRequired within parentPayment event or schedule for the signing bonus, for example FIRST_PAYROLL. Use an allowed value returned by GET /hire-requirements/.

Create hire — request body — body hires item compensation target bonus

FieldTypePresenceDescription and constraints
$objectRootBonus earned for meeting the role's target performance. Express the target as exactly one of a monetary amount or a percentage of base pay; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.
Additional keys: not allowed
amountobjectOptionalTarget bonus amount using currency_type as a three-letter ISO 4217 code and value as the decimal amount. Provide exactly one of amount or percent.
amount.currency_typestringOptionalThe currency type, ex: USD, EUR, etc.
amount.valuenumberOptionalThe decimal amount for the currency.
payment_frequencystringOptionalHow often the target bonus is paid: MONTH, QUARTER, SEMI_ANNUAL, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type.
One of: MONTH, QUARTER, SEMI_ANNUAL, YEAR
percentstringOptionalTarget bonus as a percentage of base pay, written as a numeric string without the percent sign, for example 15. Provide exactly one of amount or percent.

Create hire — request body — body hires item custom fields item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
field_idstringRequired within parentIdentifier of a company-configured custom field collected during hiring. Use a field configured for the hiring company.
valueobjectRequired within parentValue for the selected custom field. Its JSON type and allowed options depend on that field's configuration in Rippling.

Create hire — request body — body hires item employment collective bargaining

FieldTypePresenceDescription and constraints
$objectRootCollective-bargaining coverage and the applicable agreement identifiers.
Additional keys: not allowed
agreement_codestringOptionalOfficial country-specific identifier of the applicable collective bargaining agreement. This is an external statutory code, not a Rippling resource ID; GET /hire-requirements/ describes its source and format for the selected country.
agreement_namestringOptionalName of the employer's applicable collective labor or bargaining agreement. Provide it only when a named agreement applies; other union activity does not require a name. Use an allowed value from GET /hire-requirements/.
areastringOptionalGeographic or industry area governed by the agreement.
coveragestringOptionalWhether a collective bargaining agreement covers the worker.
One of: COVERED, NOT_COVERED
groupstringOptionalWorker group or category within the applicable agreement.
has_union_activitybooleanOptionalWhether the employer has a collective labor agreement, collective bargaining agreement, or other union activity in place. This is an employer-level fact and is distinct from whether an agreement covers this worker.

Create hire — request body — body hires item employment contract

FieldTypePresenceDescription and constraints
$objectRootEmployment term: ongoing with no predetermined end or fixed for a defined term.
Additional keys: not allowed
durationobjectOptionalExact fixed-term length. Use only with type FIXED; omit for INDEFINITE.
Additional keys: not allowed
duration.unitstringRequired within parentDuration unit: DAYS, WEEKS, MONTHS, or YEARS.
One of: DAYS, WEEKS, MONTHS, YEARS
duration.valueintegerRequired within parentPositive number of duration units.
minimum_guaranteed_durationobjectOptionalMinimum contract length guaranteed to the worker, distinct from the exact total duration.
Additional keys: not allowed
minimum_guaranteed_duration.unitstringRequired within parentDuration unit: DAYS, WEEKS, MONTHS, or YEARS.
One of: DAYS, WEEKS, MONTHS, YEARS
minimum_guaranteed_duration.valueintegerRequired within parentPositive number of duration units.
missionModelOptionalExpand Create hire — request body — body hires item employment contract mission
typestringRequired within parentWhether employment is ongoing or fixed-term. Use INDEFINITE when there is no predetermined end and FIXED when the employment is limited to a defined term.
One of: FIXED, INDEFINITE

Referenced models: Create hire — request body — body hires item employment contract mission

Create hire — request body — body hires item employment contract mission

FieldTypePresenceDescription and constraints
$objectRootMission-specific contract facts, only when listed by GET /hire-requirements/.
Additional keys: not allowed
descriptionstringOptionalDescription of the mission or project. Required when has_defined_timeline is true; omit when there is no defined mission timeline.
has_defined_timelinebooleanRequired within parentWhether the assignment or project has a defined completion timeline.

Create hire — request body — body hires item employment framework agreement

FieldTypePresenceDescription and constraints
$objectRootAdditional German framework-agreement clauses that are not already represented by compensation, hours, or vacation.
Additional keys: not allowed
additional_benefitsstringRequired within parentAdditional benefits stated in the framework agreement.
continued_remuneration_termsstringRequired within parentFramework-agreement continued-remuneration terms.
other_working_conditionsstringRequired within parentOther essential working conditions in the framework agreement.
overtime_pay_termsstringRequired within parentFramework-agreement overtime-pay terms.
rest_periodsstringRequired within parentRest-period terms stated in the framework agreement.
shared_facilitiesstringRequired within parentShared facilities available to the worker.
surchargesstringRequired within parentSurcharges required by the framework agreement.
variable_compensation_termsstringRequired within parentFramework-agreement variable-compensation terms.
work_wearstringRequired within parentFunctional workwear supplied for the engagement.

Create hire — request body — body hires item employment modern award

FieldTypePresenceDescription and constraints
$objectRootAustralian modern-award coverage and classification for this job. Required for Australian hires. Send coverage NOT_COVERED when no award applies; otherwise send COVERED with the applicable award and classification identifiers.
Additional keys: not allowed
award_idstringOptionalIdentifier of the Australian modern award governing the job. Required when coverage is COVERED; omit when coverage is NOT_COVERED. Select a currently active identifier from award_id.allowed_values returned by GET /hire-requirements/. This is a catalog identifier, not an expandable Platform API relationship.
classification_idstringOptionalIdentifier of the worker's classification within the selected modern award. This classification captures the applicable level or sub-level. Required when coverage is COVERED; omit when coverage is NOT_COVERED. Select an identifier from classification_id.allowed_values returned by GET /hire-requirements/ and use allowed_value_parents to match it to award_id. This is a catalog identifier, not an expandable Platform API relationship.
coveragestringRequired within parentWhether an Australian modern award covers this job. Use NOT_COVERED when no modern award applies. Use COVERED together with award_id and classification_id when one applies.
One of: COVERED, NOT_COVERED

Create hire — request body — body hires item employment notice

FieldTypePresenceDescription and constraints
$objectRootNotice-period arrangement for ending employment: standard or a custom period.
Additional keys: not allowed
quantityintegerOptionalNumber of notice-period units. Required for CUSTOM_NOTICE; omit for STANDARD_NOTICE.
typestringRequired within parentNotice-period arrangement for ending employment. STANDARD_NOTICE applies the standard period; CUSTOM_NOTICE supplies a specific period.
One of: STANDARD_NOTICE, CUSTOM_NOTICE
unitstringOptionalUnit for the custom notice period: DAYS, WEEKS, MONTHS, or YEARS. Required for CUSTOM_NOTICE; omit for STANDARD_NOTICE.
One of: DAYS, WEEKS, MONTHS, YEARS

Create hire — request body — body hires item employment probation

FieldTypePresenceDescription and constraints
$objectRootProbation arrangement for the employment: standard, a shorter custom period, or none.
Additional keys: not allowed
quantityintegerOptionalNumber of probation units. Required for SHORTER_PROBATION; omit otherwise.
typestringRequired within parentProbation arrangement for the employment. STANDARD_PROBATION applies the standard period, SHORTER_PROBATION supplies a shorter custom period, and FORGO_PROBATION means no probation.
One of: STANDARD_PROBATION, SHORTER_PROBATION, FORGO_PROBATION
unitstringOptionalUnit for the custom probation length: DAYS, WEEKS, MONTHS, or YEARS. Required for SHORTER_PROBATION; omit otherwise.
One of: DAYS, WEEKS, MONTHS, YEARS

Create hire — request body — body hires item employment regular working hours

FieldTypePresenceDescription and constraints
$objectRootThe role's usual working days and, where required, its local daily start and end times. This describes the regular work pattern; weekly_hours remains the total expected hours per week. For Mexico EOR, the object is optional and may contain only days; omission defaults to Monday through Friday.
Additional keys: not allowed
daysarrayRequired within parentWeekdays the worker ordinarily works. Use uppercase values such as MONDAY and FRIDAY. For Mexico EOR, this is the only accepted member of regular_working_hours; omitting the whole object defaults to Monday through Friday.
days[]JSONEach itemOne of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
days_per_weekintegerOptionalNumber of days ordinarily worked per week, such as 5.
days_per_yearintegerOptionalNumber of days ordinarily worked per year, when the country tracks annual working days.
end_timestringOptionalUsual local end time on a working day in HH:MM:SS format, such as 17:00:00. This is a wall-clock time in time_zone, not a UTC timestamp. Do not send for Mexico EOR.
hours_by_weekdayModelOptionalExpand Create hire — request body — body hires item employment regular working hours hours by weekday
start_timestringOptionalUsual local start time on a working day in HH:MM:SS format, such as 09:00:00. This is a wall-clock time in time_zone, not a UTC timestamp. Do not send for Mexico EOR.
time_zonestringOptionalIANA time zone used to interpret start_time and end_time, such as Australia/Sydney or Europe/London. Do not send for Mexico EOR.
tracking_unitstringOptionalUnit used to track working time when required by the country: DAYS or HOURS.
One of: DAYS, HOURS

Referenced models: Create hire — request body — body hires item employment regular working hours hours by weekday

Create hire — request body — body hires item employment regular working hours hours by weekday

FieldTypePresenceDescription and constraints
$objectRootExpected hours for each weekday. Use null for a day off.
Additional keys: not allowed
fridaystringOptionalHours worked on Friday; null means the day is off.
mondaystringOptionalHours worked on Monday; null means the day is off.
saturdaystringOptionalHours worked on Saturday; null means the day is off.
sundaystringOptionalHours worked on Sunday; null means the day is off.
thursdaystringOptionalHours worked on Thursday; null means the day is off.
tuesdaystringOptionalHours worked on Tuesday; null means the day is off.
wednesdaystringOptionalHours worked on Wednesday; null means the day is off.

Create hire — request body — body hires item employment vacation

FieldTypePresenceDescription and constraints
$objectRootHow annual paid vacation is determined: statutory entitlement or a custom annual allowance.
Additional keys: not allowed
daysintegerOptionalAnnual vacation allowance in days. Required for CUSTOM_VACATION; omit for STATUTORY_VACATION.
typestringRequired within parentHow annual paid vacation is determined. Use STATUTORY_VACATION to apply the statutory entitlement or CUSTOM_VACATION to provide a specific annual allowance in days.
One of: STATUTORY_VACATION, CUSTOM_VACATION

Create hire — request body — body hires item related records

FieldTypePresenceDescription and constraints
$objectRootReferences that associate this hire with recruiting, headcount planning, a prior employment record, or an existing Rippling hiring process. These references control hiring behavior; they are not arbitrary metadata. Omit the object when no association applies.
Additional keys: not allowed
ats_applicant_idstringOptionalRippling Recruiting applicant/application ID for the ATS application that produced this hire. Obtain it from GET /candidate-applications/. Omit when the hire is not linked to a Rippling ATS application.
existing_role_idstringOptionalRippling role ID for an in-progress hire to continue instead of starting another hiring process. Use the ID returned by a prior hire result when instructed to continue that hire.
headcount_position_idstringOptionalRippling headcount-position ID for the approved or open position this person will fill. Obtain it from GET /headcount-positions/.
rehire_choicestringOptionalHow to initialize the rehire identified by rehire_role_id. REUSE_WORKER_DETAILS prefills eligible non-compensation details from the prior employment record, while NEW_WORKER_DETAILS starts those hiring questions without that prefill. Both choices rehire the existing person identified by rehire_role_id. The request's required first_name and last_name do not replace that person's identity; invite_email or invite_phone supplies the invitation destination for the new role. Required with rehire_role_id; omit otherwise.
One of: REUSE_WORKER_DETAILS, NEW_WORKER_DETAILS
rehire_role_idstringOptionalRippling role ID for this person's prior employment record: the previous role being rehired. When POST /hires/ reports a possible_rehire next action, use its target_id here. Providing this ID starts a rehire and also requires rehire_choice.

Create hire — request body — body hires item work location

FieldTypePresenceDescription and constraints
$objectRootWhere the person will work. Provide either a Rippling work-location ID or mark the hire as remote, and always provide the work country.
Additional keys: not allowed
country_codestringRequired within parentTwo-letter ISO 3166-1 country code for the place where the person performs the work, such as US or CA. Required for both office-based and remote hires and used to determine country-specific hiring requirements.
is_remotebooleanOptionalWhether the person works remotely rather than from a company work location. When true, omit location_id and provide country_code plus state_code when applicable. Defaults to false.
location_idstringOptionalRippling work-location ID for the office or site where the person will work. Obtain it from GET /work-locations/. Required when is_remote is false; omit when is_remote is true.
state_codestringOptionalState, province, or region code for a remote work location, such as CA for California. Supply it when the selected country requires a regional location; omit it for an office-based hire whose work-location record already identifies the region.

Create hire — response body — results

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
resultsarrayRequired within parentOne result per request hire, in request order. HTTP 200 means the envelope was accepted; each item's status is the outcome.
results[]ModelEach itemExpand Create hire — response body — results results item

Referenced models: Create hire — response body — results results item

Create hire — response body — results results item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
client_request_idstringOptionalEcho of the caller-supplied item id.
errorsarrayOptionalStructured item errors using the same public field paths as GET /hire-requirements/.
errors[]ModelEach itemExpand Create hire — response body — results results item errors item
existing_role_idstringOptionalMatching existing role id for duplicate or rehire conflicts.
idstringOptionalRippling hire role id when a role exists.
missing_required_fieldsarrayOptionalPublic field paths still required before review.
missing_required_fields[]stringEach item
next_actionsarrayOptionalActions for duplicate, rehire, or Auto-Hire failures and blockers.
next_actions[]ModelEach itemExpand Create hire — response body — results results item next actions item
pending_fieldsarrayOptionalAccepted public field paths not yet active because progression is blocked.
pending_fields[]stringEach item
statusstringRequired within parentready_for_review, auto_hire_processing, incomplete, or failed. auto_hire_processing includes hires awaiting approval or asynchronous completion.

Referenced models: Create hire — response body — results results item errors item, Create hire — response body — results results item next actions item

Create hire — response body — results results item errors item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
codestringRequired within parentMachine-readable error code.
fieldstringOptionalPublic field path when the error is field-scoped.
messagestringRequired within parentHuman-readable error message.

Create hire — response body — results results item next actions item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
codestringRequired within parentMachine-readable next action. Supported values:

- `continue_existing_hire`: Continue the matching in-progress hire.
- `provide_rehire_choice`: Choose how to rehire the matching former worker.

When Auto-Hire is enabled and blocked or fails to start:

- `assign_device_in_rippling`: Assign a device in Rippling.
- `provide_document_values`: Complete missing document details.
- `review_devices_in_rippling`: Review devices in Rippling.
- `review_documents_in_rippling`: Review documents in Rippling.
- `review_work_email_in_rippling`: Review work email in Rippling.
- `review_work_pattern_in_rippling`: Review the work pattern in Rippling.
- `review_retirement_in_rippling`: Review retirement enrollment in Rippling.
- `configure_offer_notification`: Configure the offer notification.
- `provide_missing_hire_input`: Complete missing hire details.
- `review_hire_in_rippling`: Review the hire in Rippling.
- `resolve_hire_issue_in_rippling`: Resolve the hire issue in Rippling.
target_idstringOptionalRole id the caller should continue, when applicable.

Delist listing — response body

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation timestamp.
draft_statusstringOptionalThe current draft-cycle slot status.
draft_versionModelOptionalExpand Delist listing — response body — draft version
draft_version_idstringOptionalThe current draft-cycle version ID.
iconstringOptionalThe listing icon URL.
listing_idstringOptionalThe listing ID.
namestringOptionalThe listing name or display name.
owner_company_idstringOptionalThe publisher company ID that owns this listing.
published_or_delisted_versionModelOptionalExpand Delist listing — response body — published or delisted version
published_statusstringOptionalThe current published slot status.
published_version_idstringOptionalThe current published or delisted version ID.
statusstringOptionalThe listing lifecycle status.
typestringOptionalThe listing app type.
updated_atstringOptionalLast update timestamp.

Referenced models: Delist listing — response body — draft version, Delist listing — response body — published or delisted version

Delist listing — response body — draft version

FieldTypePresenceDescription and constraints
$objectRootThe current editable or review listing version.
catalog_binding_idstringOptionalThe package ID tied to this listing.
catalog_binding_version_idstringOptionalThe package version ID selected by this listing version.
created_atstringOptionalCreation timestamp.
display_namestringOptionalThe display name for this version.
idstringOptionalThe listing version ID.
latest_submission_notesstringOptionalThe latest notes submitted for review.
metadataobjectOptionalListing metadata for this version.
published_atstringOptionalPublish timestamp.
statusstringOptionalThe lifecycle status for this version.
updated_atstringOptionalLast update timestamp.
version_namestringOptionalThe publisher-visible version label.

Delist listing — response body — published or delisted version

FieldTypePresenceDescription and constraints
$objectRootThe current published or delisted listing version.
catalog_binding_idstringOptionalThe package ID tied to this listing.
catalog_binding_version_idstringOptionalThe package version ID selected by this listing version.
created_atstringOptionalCreation timestamp.
display_namestringOptionalThe display name for this version.
idstringOptionalThe listing version ID.
latest_submission_notesstringOptionalThe latest notes submitted for review.
metadataobjectOptionalListing metadata for this version.
published_atstringOptionalPublish timestamp.
statusstringOptionalThe lifecycle status for this version.
updated_atstringOptionalLast update timestamp.
version_namestringOptionalThe publisher-visible version label.

Deploy a metadata component package — response body

FieldTypePresenceDescription and constraints
$objectRoot
errorModelOptionalExpand Deploy a metadata component package — response body — error
installationsarrayRequired within parentPer-component deployment results.
installations[]ModelEach itemExpand Deploy a metadata component package — response body — installations item
successbooleanRequired within parentWhether the package deployment completed.

Referenced models: Deploy a metadata component package — response body — installations item, Deploy a metadata component package — response body — error

Deploy a metadata component package — response body — error

FieldTypePresenceDescription and constraints
$objectRootA validation, dependency, permission, or deployment issue.
Additional keys: allowed
causeJSONOptional
cause (anyOf 1)stringAlternativeLower-level cause associated with the issue, when available.
cause (anyOf 2)nullAlternative
codestringRequired within parentStable machine-readable issue code.
component_typeJSONOptional
component_type (anyOf 1)stringAlternativeComponent type associated with the issue, when available.
component_type (anyOf 2)nullAlternative
messagestringRequired within parentHuman-readable remediation message.

Deploy a metadata component package — response body — installations item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
identifierobjectRequired within parentInstalled component identifier.
Additional keys: allowed
navigation_targetJSONOptional
navigation_target (anyOf 1)objectAlternativeNavigation target for the installed component, when available.
navigation_target (anyOf 1).target_typestringRequired within parentType of UI target.
navigation_target (anyOf 1).titlestringRequired within parentDisplay title for the navigation target.
navigation_target (anyOf 1).urlstringRequired within parentRelative URL for the installed component.
navigation_target (anyOf 2)nullAlternative
resultobjectOptionalType-specific install result.
Additional keys: allowed
statusstringRequired within parentPer-component install result.
Known values: SUCCESS, FAILED, SKIPPED_ALREADY_EXISTS, UPDATED, SKIPPED_NO_CHANGES
typestringRequired within parentMetadata component type.

Deploy an agent source revision — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
source_revision_idstringRequired within parentThe ID of the source revision to deploy

Evaluate a leave program evaluation — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
birth_typestringOptionalOptional delivery type for birthing-parent disability evaluations. Used to estimate postpartum disability windows for programs such as CA-SDI and CA-PDL.
One of: VAGINAL, C_SECTION, UNKNOWN
child_entered_family_datestringOptionalOptional date the child entered the family for bonding leave programs.
claim_end_datestringOptionalOptional requested leave end date. When set, leave_plan.pay_periods includes estimated per-paycheck amounts for programs that publish pay rates.
claim_start_datestringRequired within parentRequested leave start date.
evidence_overrideobjectOptionalDemo/test-company only evidence overrides for exercising eligibility scenarios when the role's real data would not qualify.
leave_reasonstringRequired within parentNormalized leave reason to evaluate against statutory and custom leave programs.
One of: BONDING, PREGNANCY_DISABILITY, PREGNANCY_ACCOMMODATION, MEDICAL, VACATION, OTHER
parental_leave_typestringOptionalOptional parental leave relationship type for parental leave programs. Deprecated for most bonding evaluations, but still accepted for backwards compatibility with 2024-08-01 SDK callers.
One of: birthing_parent, non_birthing_parent, adoption_parent, supporting_person, foster_parent
program_codesarrayOptionalOptional leave program codes to evaluate. When omitted, every registered leave program runs in dependency order.
program_codes[]stringEach item
role_idstringRequired within parentRole ID for the employee whose leave request should be evaluated.
supplemental_evidenceobjectOptionalAnswers for evidence keys returned in missing_evidence. These answers only fill facts that the evaluation reported as missing.

Evaluate a leave program evaluation — response body — leave plan balance adjustments item

FieldTypePresenceDescription and constraints
$objectRoot
accrual_typestringOptionalAccrual type to use when applying the adjustment.
amountstringRequired within parentAdjustment amount serialized as a decimal string.
leave_typestringRequired within parentLeave type to adjust if applying the evaluation.
unitstringRequired within parentUnit for the adjustment amount, such as WEEKS, DAYS, or HOURS.

Evaluate a leave program evaluation — response body — leave plan coverage segments item

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalSegment end date, if known.
program_codesarrayRequired within parentPrograms active over this segment.
program_codes[]stringEach item
start_datestringRequired within parentSegment start date.

Evaluate a leave program evaluation — response body — leave plan earnings item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentEarning amount serialized as a decimal string.
currencystringOptionalISO 4217 currency code for the earning amount.
earning_typestringRequired within parentEarning type to use if booking a payroll earning from the evaluation.
weeksstringOptionalNumber of benefit weeks represented by this earning, serialized as a decimal string.

Evaluate a leave program evaluation — response body — leave plan pay periods item

FieldTypePresenceDescription and constraints
$objectRoot
carrier_totalobjectOptionalTotal estimated carrier-paid amount in this pay period.
carrier_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
carrier_total.currencystringRequired within parentISO 4217 currency code for the amount.
contributionsarrayRequired within parentEstimated program-level pay slices in this pay period.
contributions[]ModelEach itemExpand Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item
employer_totalobjectOptionalTotal estimated employer-paid amount in this pay period.
employer_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
employer_total.currencystringRequired within parentISO 4217 currency code for the amount.
government_totalobjectOptionalTotal estimated government-paid amount in this pay period.
government_total.amountstringRequired within parentDecimal monetary amount serialized as a string.
government_total.currencystringRequired within parentISO 4217 currency code for the amount.
period_endstringRequired within parentEstimated pay period end date.
period_startstringRequired within parentEstimated pay period start date.
totalobjectOptionalTotal estimated amount in this pay period.
total.amountstringRequired within parentDecimal monetary amount serialized as a string.
total.currencystringRequired within parentISO 4217 currency code for the amount.

Referenced models: Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item

Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item

FieldTypePresenceDescription and constraints
$objectRoot
amountobjectRequired within parentEstimated amount for this program slice.
amount.amountstringRequired within parentDecimal monetary amount serialized as a string.
amount.currencystringRequired within parentISO 4217 currency code for the amount.
pay_sourcestringRequired within parentWho pays the employee for this program slice.
Known values: GOVERNMENT, CARRIER, EMPLOYER
program_codestringRequired within parentProgram contributing pay in this pay period.

Evaluate a leave program evaluation — response body — leave plan program contributions item

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalProgram placement end date, if known.
leave_typestringOptionalLeave type associated with this program placement.
leave_type_labelstringOptionalHuman-readable leave type label.
pay_statusstringRequired within parentWhether this program has an estimated pay rate.
Known values: NOT_APPLICABLE, ESTIMATED
program_codestringRequired within parentLeave program code active on this claim window.
start_datestringRequired within parentProgram placement start date.

Evaluate a leave program evaluation — response body — missing evidence item

FieldTypePresenceDescription and constraints
$objectRoot
answer_typestringRequired within parentExpected answer type for this evidence key.
keystringRequired within parentStable evidence key that can be supplied in supplemental_evidence.
labelstringRequired within parentHuman-readable label for the missing evidence.
program_codesarrayRequired within parentLeave program codes that reported this missing evidence.
program_codes[]stringEach item

Evaluate a leave program evaluation — response body — program results item

FieldTypePresenceDescription and constraints
$objectRoot
componentsarrayOptionalLegacy explanatory components for this program.
components[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item components item
directivesModelOptionalExpand Evaluate a leave program evaluation — response body — program results item directives
eligibilitystringRequired within parentDerived eligibility status for this program.
Known values: eligible, ineligible, partially_eligible
entitlementobjectOptionalTime entitlement for this program, if any.
entitlement.amountstringRequired within parentEntitlement amount serialized as a decimal string.
entitlement.leave_typestringRequired within parentLeave type associated with the entitlement.
entitlement.unitstringRequired within parentUnit for the entitlement amount, such as WEEKS, DAYS, or HOURS.
gapsarrayRequired within parentUNKNOWN evidence keys to fix before eligibility can be fully resolved.
gaps[]stringEach item
is_payablebooleanRequired within parentWhether the result is eligible and not blocked by payment-blocking requirements.
job_protectionobjectOptionalJob-protection details for this program, if any.
job_protection.continues_group_healthbooleanOptionalWhether the program continues group health coverage.
job_protection.restorationstringRequired within parentJob-restoration right provided by the program.
pay_rateobjectOptionalEstimated wage-replacement rate for this program, if any.
pay_rate.phasesarrayRequired within parentWage-replacement phases for the program.
pay_rate.phases[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item pay rate phases item
pay_sourcestringOptionalWho pays the employee for this program's wage-replacement slice.
Known values: GOVERNMENT, CARRIER, EMPLOYER
pay_summarystringOptionalHuman-readable pay summary for this program.
program_codestringRequired within parentLeave program code evaluated by the rules engine.
program_requirementsarrayOptionalOutstanding artifacts or actions for this program.
program_requirements[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item program requirements item
program_validationsarrayRequired within parentEligibility and assumption validations run for this program.
program_validations[]ModelEach itemExpand Evaluate a leave program evaluation — response body — program results item program validations item

Referenced models: Evaluate a leave program evaluation — response body — program results item pay rate phases item, Evaluate a leave program evaluation — response body — program results item program requirements item, Evaluate a leave program evaluation — response body — program results item program validations item, Evaluate a leave program evaluation — response body — program results item components item, Evaluate a leave program evaluation — response body — program results item directives

Evaluate a leave program evaluation — response body — program results item components item

FieldTypePresenceDescription and constraints
$objectRoot
dataobjectOptionalAdditional component-specific data.
kindstringRequired within parentCategory of explanatory result component.
Known values: ELIGIBILITY, PAY, TIME, OTHER
subkindstringOptionalOptional machine-readable subtype for the component.
summarystringRequired within parentHuman-readable summary for this component.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.