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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | Minimum length: 1 |
implementation_config | string | Required within parent | Minimum length: 1 |
kind | string | Required within parent | One of: registered_callback |
owner_id | string | Required within parent | Minimum length: 1 |
owner_type | string | Required within parent | Minimum length: 1 |
Create a workflow — request body — body / trigger / event_type: message posted, reaction added, kind: slack
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
allowed_sender_group_id | JSON | Optional | |
allowed_sender_group_id (anyOf 1) | string | Alternative | |
allowed_sender_group_id (anyOf 2) | null | Alternative | |
channel_ids | array | Required within parent | Minimum items: 1 |
channel_ids[] | string | Each item | |
event_type | string | Required within parent | One of: message_posted, reaction_added |
include_thread_replies | boolean | Optional | Default: false |
kind | string | Required within parent | One of: slack |
message_text_regex | JSON | Optional | |
message_text_regex (anyOf 1) | string | Alternative | Maximum length: 512 |
message_text_regex (anyOf 2) | null | Alternative | |
reaction_names | array | Optional | |
reaction_names[] | string | Each item |
Create a workflow — request body — body / trigger / kind: annual schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | integer | Required within parent | Maximum: 31 Minimum: 1 |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: annual_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
month_of_year | integer | Required within parent | Maximum: 12 Minimum: 1 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: biweekly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
days_of_week | array | Required within parent | |
days_of_week[] | integer | Each item | |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: biweekly_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: business event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
event_name | string | Required within parent | |
kind | string | Required within parent | One of: business_event |
Create a workflow — request body — body / trigger / kind: cron schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
expression | string | Required within parent | |
kind | string | Required within parent | One of: cron_schedule |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: custom schedule, unit: minutes, hours, days, weeks, months, years
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Optional | |
day_of_month (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 2) | null | Alternative | |
days_of_week | JSON | Optional | |
days_of_week (anyOf 1) | array | Alternative | |
days_of_week (anyOf 1)[] | integer | Each item | |
days_of_week (anyOf 2) | null | Alternative | |
hour | integer | Optional | Default: 0 Maximum: 23 Minimum: 0 |
interval | integer | Required within parent | Minimum: 1 |
kind | string | Required within parent | One of: custom_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
month_of_year | JSON | Optional | |
month_of_year (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
month_of_year (anyOf 2) | null | Alternative | |
start_month | JSON | Optional | |
start_month (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
start_month (anyOf 2) | null | Alternative | |
timezone | string | Required within parent | |
unit | string | Required within parent | One of: minutes, hours, days, weeks, months, years |
Create a workflow — request body — body / trigger / kind: daily schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: daily_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: inbound email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body_contains | JSON | Optional | |
body_contains (anyOf 1) | string | Alternative | |
body_contains (anyOf 2) | null | Alternative | |
has_attachment | boolean | Optional | Default: false |
kind | string | Required within parent | One of: inbound_email |
recipient_email | string | Required within parent | |
subject_contains | JSON | Optional | |
subject_contains (anyOf 1) | string | Alternative | |
subject_contains (anyOf 2) | null | Alternative |
Create a workflow — request body — body / trigger / kind: manual
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | One of: manual |
Create a workflow — request body — body / trigger / kind: monthly on day of week schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_week | integer | Required within parent | Maximum: 6 Minimum: 0 |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: monthly_on_day_of_week_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent | |
week_of_month | integer | Required within parent | Maximum: 4 Minimum: 1 |
Create a workflow — request body — body / trigger / kind: monthly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | integer | Required within parent | Maximum: 31 Minimum: 1 |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: monthly_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: one time schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | integer | Required within parent | Maximum: 31 Minimum: 1 |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: one_time_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
month_of_year | integer | Required within parent | Maximum: 12 Minimum: 1 |
timezone | string | Required within parent | |
year | integer | Required within parent | Maximum: 9999 Minimum: 1 |
Create a workflow — request body — body / trigger / kind: quarterly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | integer | Required within parent | Maximum: 31 Minimum: 1 |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: quarterly_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
month_of_year | integer | Required within parent | Maximum: 12 Minimum: 1 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: weekday schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: weekday_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent |
Create a workflow — request body — body / trigger / kind: weekly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
days_of_week | array | Required within parent | |
days_of_week[] | integer | Each item | |
hour | integer | Required within parent | Maximum: 23 Minimum: 0 |
kind | string | Required within parent | One of: weekly_schedule |
minute | integer | Optional | Default: 0 Maximum: 59 Minimum: 0 |
timezone | string | Required within parent |
Create a workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
authoring | Model | Required within parent | Expand Create a workflow — response body — authoring |
created_at | string | Required within parent | Format: date-time |
definition | JSON | Required within parent | |
definition (anyOf 1) | Model | Alternative | Expand Create a workflow — response body — definition / kind: editable |
definition (anyOf 2) | Model | Alternative | Expand Create a workflow — response body — definition / kind: read only |
deletable | boolean | Required within parent | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
enabled | boolean | Required within parent | |
has_draft | boolean | Required within parent | |
id | string | Required within parent | |
name | string | Required within parent | |
owner_id | string | Required within parent | |
status | string | Required within parent | Known values: draft, published, unknown |
updated_at | string | Required within parent | Format: date-time |
version_id | string | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
mode | string | Required within parent | Known values: full, metadata_only, read_only |
patchable_fields | array | Required within parent | |
patchable_fields[] | string | Each item | Known values: name, description, status, enabled, trigger, actions |
reason_codes | array | Required within parent | |
reason_codes[] | string | Each item | Known values: unsupported_trigger, unsupported_graph, insufficient_permission, missing_current_version |
Create a workflow — response body — definition / kind: editable
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | Minimum length: 1 |
implementation_config | string | Required within parent | Minimum length: 1 |
kind | string | Required within parent | Known values: registered_callback |
owner_id | string | Required within parent | Minimum length: 1 |
owner_type | string | Required within parent | Minimum length: 1 |
Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
allowed_sender_group_id | JSON | Optional | |
allowed_sender_group_id (anyOf 1) | string | Alternative | |
allowed_sender_group_id (anyOf 2) | null | Alternative | |
channel_ids | array | Required within parent | Minimum items: 1 |
channel_ids[] | string | Each item | |
event_type | string | Required within parent | Known values: message_posted, reaction_added |
include_thread_replies | boolean | Optional | Default: false |
kind | string | Required within parent | Known values: slack |
message_text_regex | JSON | Optional | |
message_text_regex (anyOf 1) | string | Alternative | Maximum length: 512 |
message_text_regex (anyOf 2) | null | Alternative | |
reaction_names | array | Optional | |
reaction_names[] | string | Each item |
Create a workflow — response body — definition / kind: editable trigger kind: annual schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Required within parent | |
day_of_month (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: annual_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month_of_year | JSON | Required within parent | |
month_of_year (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
month_of_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
days_of_week | array | Required within parent | |
days_of_week[] | JSON | Each item | |
days_of_week[] (anyOf 1) | integer | Alternative | |
days_of_week[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: biweekly_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: business event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
event_name | string | Required within parent | |
kind | string | Required within parent | Known values: business_event |
Create a workflow — response body — definition / kind: editable trigger kind: cron schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
expression | string | Required within parent | |
kind | string | Required within parent | Known values: cron_schedule |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Optional | |
day_of_month (anyOf 1) | JSON | Alternative | |
day_of_month (anyOf 1) (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
day_of_month (anyOf 2) | null | Alternative | |
days_of_week | JSON | Optional | |
days_of_week (anyOf 1) | array | Alternative | |
days_of_week (anyOf 1)[] | JSON | Each item | |
days_of_week (anyOf 1)[] (anyOf 1) | integer | Alternative | |
days_of_week (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
days_of_week (anyOf 2) | null | Alternative | |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | Default: 0 Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interval | JSON | Required within parent | |
interval (anyOf 1) | integer | Alternative | Minimum: 1 |
interval (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: custom_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month_of_year | JSON | Optional | |
month_of_year (anyOf 1) | JSON | Alternative | |
month_of_year (anyOf 1) (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
month_of_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month_of_year (anyOf 2) | null | Alternative | |
start_month | JSON | Optional | |
start_month (anyOf 1) | JSON | Alternative | |
start_month (anyOf 1) (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
start_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_month (anyOf 2) | null | Alternative | |
timezone | string | Required within parent | |
unit | string | Required within parent | Known values: minutes, hours, days, weeks, months, years |
Create a workflow — response body — definition / kind: editable trigger kind: daily schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: daily_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: inbound email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body_contains | JSON | Optional | |
body_contains (anyOf 1) | string | Alternative | |
body_contains (anyOf 2) | null | Alternative | |
has_attachment | boolean | Optional | Default: false |
kind | string | Required within parent | Known values: inbound_email |
recipient_email | string | Required within parent | |
subject_contains | JSON | Optional | |
subject_contains (anyOf 1) | string | Alternative | |
subject_contains (anyOf 2) | null | Alternative |
Create a workflow — response body — definition / kind: editable trigger kind: manual
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | Known values: manual |
Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_week | JSON | Required within parent | |
day_of_week (anyOf 1) | integer | Alternative | Maximum: 6 Minimum: 0 |
day_of_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: monthly_on_day_of_week_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent | |
week_of_month | JSON | Required within parent | |
week_of_month (anyOf 1) | integer | Alternative | Maximum: 4 Minimum: 1 |
week_of_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Required within parent | |
day_of_month (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: monthly_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: one time schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Required within parent | |
day_of_month (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: one_time_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month_of_year | JSON | Required within parent | |
month_of_year (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
month_of_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent | |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | Maximum: 9999 Minimum: 1 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
day_of_month | JSON | Required within parent | |
day_of_month (anyOf 1) | integer | Alternative | Maximum: 31 Minimum: 1 |
day_of_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: quarterly_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month_of_year | JSON | Required within parent | |
month_of_year (anyOf 1) | integer | Alternative | Maximum: 12 Minimum: 1 |
month_of_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: weekday_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
days_of_week | array | Required within parent | |
days_of_week[] | JSON | Each item | |
days_of_week[] (anyOf 1) | integer | Alternative | |
days_of_week[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Required within parent | |
hour (anyOf 1) | integer | Alternative | Maximum: 23 Minimum: 0 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
kind | string | Required within parent | Known values: weekly_schedule |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | Default: 0 Maximum: 59 Minimum: 0 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timezone | string | Required within parent |
Create a workflow — response body — definition / kind: read only
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | Known values: read_only |
steps | array | Required within parent | |
steps[] | Model | Each item | Expand Create a workflow — response body — definition / kind: read only steps item |
trigger | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | |
kind | string | Required within parent | Known values: read_only |
name | string | Required within parent | |
next_ids | array | Required within parent | |
next_ids[] | string | Each item | |
source_type | string | Required within parent | Known values: action, fork, loop, switch, group, unknown |
Create a workflow — response body — definition / kind: read only trigger
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | Known values: read_only |
source_type | string | Required within parent | Known values: business_event, record_change, scheduled, manual, webhook, date_relative, integration, unknown |
summary | string | Required within parent |
Create an agent session — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agent_id | string | Required within parent | The ID of the agent to run |
prompt | string | Required within parent | The prompt to send to the agent |
session_resume_state | object | Optional | Optional opaque state used to restore the new session |
session_resume_state.artifact | string | Required within parent | An opaque base64-encoded agent session resume state |
Create an agent source revision — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entrypoint | string | Required within parent | The entrypoint file |
files | array | Required within parent | The files in the source revision |
files[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content | string | Required within parent | The contents of the source file |
kind | string | Required within parent | The source file language or format |
path | string | Required within parent | The path of the source file |
Create bulk draft hire — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
draft_hires | array | Required within parent | List of draft hires |
draft_hires[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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_fields | array | Optional | Custom fields for the draft hire |
custom_fields[] | Model | Each item | Expand Create bulk draft hire — request body — body draft hires item custom fields item |
documents | array | Optional | Documents to attach to this draft hire |
documents[] | Model | Each item | Expand Create a new employee document — response body — items item documents item |
employment_info | object | Required within parent | Employment information for the draft hire position |
employment_info.contract_end_date | string | Optional | Contract end date |
employment_info.currency | string | Optional | Currency |
employment_info.department_id | string | Optional | Department ID |
employment_info.duties | string | Optional | Duties |
employment_info.eeoc_job_classification | string | Optional | EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS, SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS, SERVICE_WORKERS) |
employment_info.employment_type_id | string | Required within parent | Employment type ID |
employment_info.equity_num_shares | integer | Optional | Equity number of shares |
employment_info.equity_value | number | Optional | Equity value |
employment_info.equity_vesting_schedule | Model | Optional | Expand Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule |
employment_info.job_family_id | string | Optional | Job family ID |
employment_info.job_title | string | Optional | Job title |
employment_info.legal_entity_id | string | Optional | Legal entity ID |
employment_info.level_id | string | Optional | Level ID |
employment_info.manager_id | string | Optional | Manager ID |
employment_info.offer_expiration_date | string | Optional | Offer expiration date |
employment_info.on_target_commission | number | Optional | On target commission |
employment_info.overtime_exemption | string | Optional | Overtime exemption One of: exempt, non-exempt |
employment_info.probation_end_date | string | Optional | Probation end date |
employment_info.relocation_reimbursement | number | Optional | Relocation reimbursement |
employment_info.salary_per_unit | number | Optional | Salary per unit |
employment_info.salary_unit | string | Optional | Salary unit |
employment_info.signing_bonus | number | Optional | Signing bonus |
employment_info.start_date | string | Optional | Start date |
employment_info.target_annual_bonus | number | Optional | Target annual bonus |
employment_info.target_annual_bonus_percent | number | Optional | Target annual bonus as a percentage |
employment_info.teams_ids | array | Optional | Teams IDs |
employment_info.teams_ids[] | string | Each item | |
employment_info.title | string | Required within parent | Title |
employment_info.weekly_hours | number | Optional | Weekly hours |
employment_info.work_email | string | Optional | Work email |
headcount_info | object | Optional | Headcount 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_id | string | Required within parent | The Position ID (PID) of the headcount allocation to fill (e.g., PID100615) |
personal_info | object | Required within parent | Personal information for the draft hire candidate |
personal_info.citizenship | string | Optional | Citizenship of the candidate |
personal_info.date_of_birth | string | Optional | Date of birth |
personal_info.emergency_contact_name | string | Optional | Emergency contact name |
personal_info.emergency_contact_phone | Model | Optional | Expand Create bulk draft hire — request body — body draft hires item personal info emergency contact phone |
personal_info.ethnicity | string | Optional | Ethnicity of the candidate |
personal_info.gender | string | Optional | Gender of the candidate |
personal_info.home_address | Model | Optional | Expand Create bulk draft hire — request body — body draft hires item personal info home address |
personal_info.invite_email | string | Required within parent | Invite email of the candidate |
personal_info.locale | Model | Optional | Expand Create bulk draft hire — request body — body draft hires item personal info locale |
personal_info.name | Model | Required within parent | Expand Create bulk draft hire — request body — body draft hires item personal info name |
personal_info.personal_phone | Model | Optional | Expand Create bulk draft hire — request body — body draft hires item personal info personal phone |
personal_info.race | string | Optional | Race of the candidate |
personal_info.ssn | string | Optional | Social security number of the candidate |
work_location_info | object | Required within parent | Work location information |
work_location_info.country_code | string | Optional | Country code of the work location |
work_location_info.is_remote | boolean | Optional | Whether the work location is remote |
work_location_info.location_id | string | Optional | Work location ID |
work_location_info.state_code | string | Optional | State 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom field information for a draft hire. Custom fields are associated with RoleWithCompany model. |
field_name | string | Required within parent | Name of the custom field |
field_value | object | Required within parent | Value of the custom field |
Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Equity vesting schedule |
_name | string | Optional | Name of the vesting schedule |
cliffMonths | integer | Optional | Number of cliff months before vesting begins |
company_id | string | Required within parent | Required company ID for the vesting schedule |
continuousVestingMonths | integer | Optional | Number of continuous vesting months |
percentageInitialVesting | number | Optional | Percentage of initial vesting as decimal Format: decimal |
spokeId | string | Optional | Spoke ID for the vesting schedule |
totalVestingMonths | integer | Optional | Total number of vesting months |
totalVestingYears | integer | Optional | Total number of vesting years |
vestingType | string | Optional | Type of vesting schedule |
Create bulk draft hire — request body — body draft hires item personal info emergency contact phone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Emergency contact phone |
country_code | string | Optional | Country code for the phone number |
extension | string | Optional | Phone number extension |
national_number | string | Optional | National phone number without country code |
Create bulk draft hire — request body — body draft hires item personal info home address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Optional | The 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 |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The 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.. |
type | string | Optional | The classification of the address. One of: HOME, WORK, OTHER |
Create bulk draft hire — request body — body draft hires item personal info locale
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Locale of the candidate |
language_code | string | Optional | The primary language code |
language_inspection | array | Optional | Additional language inspection data |
language_inspection[] | string | Each item | |
locale_code | string | Optional | The locale code for formatting |
region_code | string | Optional | The region code |
timezone | string | Optional | The user's timezone |
Create bulk draft hire — request body — body draft hires item personal info name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Name of the candidate |
first | string | Optional | First name or given name |
last | string | Optional | Last name or family name |
middle | string | Optional | Middle name(s) |
nickname | string | Optional | Preferred nickname or informal name |
suffix | string | Optional | Name suffix (e.g., Jr., Sr., III) |
title | string | Optional | Title or honorific (e.g., Mr., Ms., Dr.) |
Create bulk draft hire — request body — body draft hires item personal info personal phone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Personal phone number |
country_code | string | Optional | Country code for the phone number |
extension | string | Optional | Phone number extension |
national_number | string | Optional | National phone number without country code |
Create bulk draft hire — response body — invalid items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result for an individual draft hire creation. |
draft_hire_role_id | string | Optional | Generated draft hire ID if successful |
errors | array | Optional | List of validation errors if any |
errors[] | string | Each item | |
message | string | Optional | Success or error message |
status | string | Required within parent | Status of the creation (success, error, warning) |
Create hire — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
hires | array | Required within parent | One to five hire submissions. Results are returned in the same order. |
hires[] | Model | Each item | Expand Create hire — request body — body hires item |
Referenced models: Create hire — request body — body hires item
Create hire — request body — body hires item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One hire on POST /hires/. Country-specific employment fields come from GET /hire-requirements/. Additional keys: not allowed |
client_request_id | string | Optional | Optional id echoed on that hire's result. Not a hire field. |
compensation | object | Optional | Base 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_amount | Model | Optional | Expand Create hire — request body — body hires item compensation base pay amount |
compensation.base_pay_period | string | Optional | Unit 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_allowance | object | Optional | Mexico 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
compensation.car_allowance.value | number | Optional | The decimal amount for the currency. |
compensation.christmas_bonus_days | integer | Optional | Mexico 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.commission | Model | Optional | Expand Create hire — request body — body hires item compensation commission |
compensation.equity | Model | Optional | Expand Create hire — request body — body hires item compensation equity |
compensation.grocery_coupon | object | Optional | Mexico 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
compensation.grocery_coupon.value | number | Optional | The decimal amount for the currency. |
compensation.relocation | Model | Optional | Expand Create hire — request body — body hires item compensation relocation |
compensation.relocation_expense | object | Optional | Mexico 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
compensation.relocation_expense.value | number | Optional | The decimal amount for the currency. |
compensation.remote_working_allowance | Model | Optional | Expand Create hire — request body — body hires item compensation remote working allowance |
compensation.savings_fund_percent | string | Optional | Mexico 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_bonus | Model | Optional | Expand Create hire — request body — body hires item compensation signing bonus |
compensation.target_bonus | Model | Optional | Expand Create hire — request body — body hires item compensation target bonus |
compensation.telecom_allowance | object | Optional | Mexico 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
compensation.telecom_allowance.value | number | Optional | The decimal amount for the currency. |
compensation.thirteenth_month_bonus | object | Optional | Contractually 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
compensation.thirteenth_month_bonus.value | number | Optional | The decimal amount for the currency. |
compensation.vacation_premium_percent | string | Optional | Mexico 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_fields | array | Optional | Values 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[] | Model | Each item | Expand Create hire — request body — body hires item custom fields item |
employment | object | Required within parent | The job: title, hours, and country-specific details. Additional keys: not allowed |
employment.authorized_to_work | boolean | Optional | Whether 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_bargaining | Model | Optional | Expand Create hire — request body — body hires item employment collective bargaining |
employment.company_equipment | string | Optional | Mexico EOR. Free-text description of equipment the company assigns. Optional. |
employment.company_uses_digital_currency | boolean | Optional | Whether 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.contract | Model | Optional | Expand Create hire — request body — body hires item employment contract |
employment.contractor_paying_entity_type | string | Optional | COMPANY_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_basis | string | Optional | Mexico 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_id | string | Optional | Department id from GET /departments/. |
employment.duties | string | Optional | Plain-text summary of the role's primary responsibilities and day-to-day work. |
employment.employment_model | string | Optional | Employment 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_id | string | Required within parent | Employment 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.engagement | object | Optional | Professional field and consulting-project details required by the hire context. Additional keys: not allowed |
employment.engagement.consulting_project_description | string | Required within parent | Description of the client project and the work the worker will perform. |
employment.engagement.field_of_work | string | Required within parent | Professional field in which the worker will perform the engagement. |
employment.eor_costs_acknowledged | boolean | Optional | Confirms 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_acknowledged | boolean | Optional | Confirms 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_agreement | Model | Optional | Expand Create hire — request body — body hires item employment framework agreement |
employment.french_occupation_classification_code | string | Optional | French 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_merger | boolean | Optional | Required for GB and IE EOR. True if this hire is from a merger or acquisition. |
employment.is_eor_transfer | boolean | Optional | Whether 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_worker | boolean | Optional | Whether 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_role | boolean | Optional | Whether 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_classification | string | Optional | US EEO-1 job category for the role. Use a value returned by GET /hire-requirements/. Omit for contractor hires. |
employment.job_function_id | string | Optional | Job function that categorizes the type of work performed by this role. Send an id returned by GET /job-functions/. |
employment.legal_entity_id | string | Optional | Send 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_id | string | Optional | Job level for the role within the company's job architecture. Send an id returned by GET /levels/. |
employment.manager_id | string | Optional | Manager worker id from GET /workers/. Omit or null for no manager. |
employment.meets_eor_eligibility_criteria | boolean | Optional | Confirms 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_award | Model | Optional | Expand Create hire — request body — body hires item employment modern award |
employment.non_compete | boolean | Optional | Whether the proposed employment terms include a non-compete restriction. Provide only when listed by GET /hire-requirements/. |
employment.notice | Model | Optional | Expand Create hire — request body — body hires item employment notice |
employment.overtime_classification | string | Optional | The 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_country | boolean | Optional | Whether 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_currency | boolean | Optional | Mexico EOR. True when pay is in a currency other than Mexican pesos. Optional. Omitting this uses false. |
employment.paid_sick_days | integer | Optional | Annual company-provided paid sick-day allowance, excluding any separate statutory entitlement. Provide only when listed by GET /hire-requirements/. |
employment.position_of_trust | boolean | Optional | Required for Mexico direct hire and EOR. True when this person is a manager or director in a position of trust; otherwise false. |
employment.probation | Model | Optional | Expand Create hire — request body — body hires item employment probation |
employment.receives_tips | boolean | Optional | Whether the worker is expected to receive tips as part of this job. Omit for contractor hires. |
employment.regular_working_hours | Model | Optional | Expand Create hire — request body — body hires item employment regular working hours |
employment.requires_training | boolean | Optional | Whether 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_composition | string | Optional | Mexico 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_type | string | Optional | The 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_code | string | Optional | US Standard Occupational Classification code for the job, such as 15-1252. Omit for contractor hires. |
employment.social_contribution_city | string | Optional | Chinese 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_date | string | Optional | Start date in YYYY-MM-DD format. |
employment.statutory_contract_classification | string | Optional | Country-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_classification | string | Optional | Statutory 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_documents | object | Optional | Employment documents required to prepare the hire. Additional keys: not allowed |
employment.supporting_documents.resume_file_id | string | Optional | Id of the confirmed company-owned PDF or Word resume uploaded through POST /files/. |
employment.supporting_documents.variable_compensation_plan_file_id | string | Optional | Id of the confirmed company-owned PDF or Word variable-compensation plan. |
employment.team_ids | array | Optional | Teams the worker should belong to. Send team ids returned by GET /teams/. Omit for no team assignments. |
employment.team_ids[] | string | Each item | |
employment.title | string | Required within parent | Job title. |
employment.use_default_tenure | boolean | Optional | Set to true to start tenure on the start date. False keeps a prior tenure date unset. |
employment.vacation | Model | Optional | Expand Create hire — request body — body hires item employment vacation |
employment.vacation_rollover_days | integer | Optional | Maximum unused vacation days the worker may carry into the next leave year. Provide only when listed by GET /hire-requirements/. |
employment.weekly_hours | string | Optional | Expected 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_email | string | Optional | Work email for the hire. |
employment.work_email_required | boolean | Optional | Set 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_shift | string | Optional | Required 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_qualification | string | Optional | Worker'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_arrangement | string | Optional | Working-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_industry | boolean | Optional | Whether 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_type | string | Optional | Employment 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. |
personal | object | Optional | The person's legal name and the email address or mobile number used to send their invitation. Additional keys: not allowed |
personal.first_name | string | Optional | Person's legal given name as it should appear on employment and payroll records. |
personal.invite_email | string | Optional | Email 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_phone | string | Optional | Mobile 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_name | string | Optional | Person's legal family name as it should appear on employment and payroll records. |
personal.nationality_code | string | Optional | Person'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_records | Model | Optional | Expand Create hire — request body — body hires item related records |
work_location | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Gross 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
value | number | Optional | The decimal amount for the currency. |
Create hire — request body — body hires item compensation commission
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Variable 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_amount | object | Required within parent | Expected 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
on_target_amount.value | number | Optional | The decimal amount for the currency. |
payment_frequency | string | Optional | How 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Equity 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 |
amount | object | Required within parent | Monetary value assigned to the equity grant, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
frequency | string | Optional | Grant frequency when applicable: ONE_TIME or ANNUAL. One of: ONE_TIME, ANNUAL |
num_shares | integer | Optional | Number of shares or units included in the grant, when the grant is expressed in shares. |
Create hire — request body — body hires item compensation relocation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One-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 |
amount | object | Required within parent | Total relocation reimbursement or benefit, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
Create hire — request body — body hires item compensation remote working allowance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Recurring 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
value | number | Optional | The decimal amount for the currency. |
Create hire — request body — body hires item compensation signing bonus
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One-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 |
amount | object | Required within parent | Total one-time signing bonus, using currency_type as a three-letter ISO 4217 code and value as the decimal amount. |
amount.currency_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
payment_days | integer | Optional | Number of days after the applicable start or schedule event when the bonus is paid, if used. |
schedule | string | Required within parent | Payment 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Bonus 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 |
amount | object | Optional | Target 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_type | string | Optional | The currency type, ex: USD, EUR, etc. |
amount.value | number | Optional | The decimal amount for the currency. |
payment_frequency | string | Optional | How 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 |
percent | string | Optional | Target 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
field_id | string | Required within parent | Identifier of a company-configured custom field collected during hiring. Use a field configured for the hiring company. |
value | object | Required within parent | Value 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Collective-bargaining coverage and the applicable agreement identifiers. Additional keys: not allowed |
agreement_code | string | Optional | Official 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_name | string | Optional | Name 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/. |
area | string | Optional | Geographic or industry area governed by the agreement. |
coverage | string | Optional | Whether a collective bargaining agreement covers the worker. One of: COVERED, NOT_COVERED |
group | string | Optional | Worker group or category within the applicable agreement. |
has_union_activity | boolean | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment term: ongoing with no predetermined end or fixed for a defined term. Additional keys: not allowed |
duration | object | Optional | Exact fixed-term length. Use only with type FIXED; omit for INDEFINITE. Additional keys: not allowed |
duration.unit | string | Required within parent | Duration unit: DAYS, WEEKS, MONTHS, or YEARS. One of: DAYS, WEEKS, MONTHS, YEARS |
duration.value | integer | Required within parent | Positive number of duration units. |
minimum_guaranteed_duration | object | Optional | Minimum contract length guaranteed to the worker, distinct from the exact total duration. Additional keys: not allowed |
minimum_guaranteed_duration.unit | string | Required within parent | Duration unit: DAYS, WEEKS, MONTHS, or YEARS. One of: DAYS, WEEKS, MONTHS, YEARS |
minimum_guaranteed_duration.value | integer | Required within parent | Positive number of duration units. |
mission | Model | Optional | Expand Create hire — request body — body hires item employment contract mission |
type | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Mission-specific contract facts, only when listed by GET /hire-requirements/. Additional keys: not allowed |
description | string | Optional | Description of the mission or project. Required when has_defined_timeline is true; omit when there is no defined mission timeline. |
has_defined_timeline | boolean | Required within parent | Whether the assignment or project has a defined completion timeline. |
Create hire — request body — body hires item employment framework agreement
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional German framework-agreement clauses that are not already represented by compensation, hours, or vacation. Additional keys: not allowed |
additional_benefits | string | Required within parent | Additional benefits stated in the framework agreement. |
continued_remuneration_terms | string | Required within parent | Framework-agreement continued-remuneration terms. |
other_working_conditions | string | Required within parent | Other essential working conditions in the framework agreement. |
overtime_pay_terms | string | Required within parent | Framework-agreement overtime-pay terms. |
rest_periods | string | Required within parent | Rest-period terms stated in the framework agreement. |
shared_facilities | string | Required within parent | Shared facilities available to the worker. |
surcharges | string | Required within parent | Surcharges required by the framework agreement. |
variable_compensation_terms | string | Required within parent | Framework-agreement variable-compensation terms. |
work_wear | string | Required within parent | Functional workwear supplied for the engagement. |
Create hire — request body — body hires item employment modern award
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Australian 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_id | string | Optional | Identifier 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_id | string | Optional | Identifier 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. |
coverage | string | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Notice-period arrangement for ending employment: standard or a custom period. Additional keys: not allowed |
quantity | integer | Optional | Number of notice-period units. Required for CUSTOM_NOTICE; omit for STANDARD_NOTICE. |
type | string | Required within parent | Notice-period arrangement for ending employment. STANDARD_NOTICE applies the standard period; CUSTOM_NOTICE supplies a specific period. One of: STANDARD_NOTICE, CUSTOM_NOTICE |
unit | string | Optional | Unit 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Probation arrangement for the employment: standard, a shorter custom period, or none. Additional keys: not allowed |
quantity | integer | Optional | Number of probation units. Required for SHORTER_PROBATION; omit otherwise. |
type | string | Required within parent | Probation 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 |
unit | string | Optional | Unit 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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 |
days | array | Required within parent | Weekdays 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[] | JSON | Each item | One of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
days_per_week | integer | Optional | Number of days ordinarily worked per week, such as 5. |
days_per_year | integer | Optional | Number of days ordinarily worked per year, when the country tracks annual working days. |
end_time | string | Optional | Usual 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_weekday | Model | Optional | Expand Create hire — request body — body hires item employment regular working hours hours by weekday |
start_time | string | Optional | Usual 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_zone | string | Optional | IANA time zone used to interpret start_time and end_time, such as Australia/Sydney or Europe/London. Do not send for Mexico EOR. |
tracking_unit | string | Optional | Unit 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Expected hours for each weekday. Use null for a day off. Additional keys: not allowed |
friday | string | Optional | Hours worked on Friday; null means the day is off. |
monday | string | Optional | Hours worked on Monday; null means the day is off. |
saturday | string | Optional | Hours worked on Saturday; null means the day is off. |
sunday | string | Optional | Hours worked on Sunday; null means the day is off. |
thursday | string | Optional | Hours worked on Thursday; null means the day is off. |
tuesday | string | Optional | Hours worked on Tuesday; null means the day is off. |
wednesday | string | Optional | Hours worked on Wednesday; null means the day is off. |
Create hire — request body — body hires item employment vacation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | How annual paid vacation is determined: statutory entitlement or a custom annual allowance. Additional keys: not allowed |
days | integer | Optional | Annual vacation allowance in days. Required for CUSTOM_VACATION; omit for STATUTORY_VACATION. |
type | string | Required within parent | How 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | References 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_id | string | Optional | Rippling 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_id | string | Optional | Rippling 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_id | string | Optional | Rippling headcount-position ID for the approved or open position this person will fill. Obtain it from GET /headcount-positions/. |
rehire_choice | string | Optional | How 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_id | string | Optional | Rippling 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where 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_code | string | Required within parent | Two-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_remote | boolean | Optional | Whether 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_id | string | Optional | Rippling 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_code | string | Optional | State, 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
results | array | Required within parent | One result per request hire, in request order. HTTP 200 means the envelope was accepted; each item's status is the outcome. |
results[] | Model | Each item | Expand Create hire — response body — results results item |
Referenced models: Create hire — response body — results results item
Create hire — response body — results results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
client_request_id | string | Optional | Echo of the caller-supplied item id. |
errors | array | Optional | Structured item errors using the same public field paths as GET /hire-requirements/. |
errors[] | Model | Each item | Expand Create hire — response body — results results item errors item |
existing_role_id | string | Optional | Matching existing role id for duplicate or rehire conflicts. |
id | string | Optional | Rippling hire role id when a role exists. |
missing_required_fields | array | Optional | Public field paths still required before review. |
missing_required_fields[] | string | Each item | |
next_actions | array | Optional | Actions for duplicate, rehire, or Auto-Hire failures and blockers. |
next_actions[] | Model | Each item | Expand Create hire — response body — results results item next actions item |
pending_fields | array | Optional | Accepted public field paths not yet active because progression is blocked. |
pending_fields[] | string | Each item | |
status | string | Required within parent | ready_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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
code | string | Required within parent | Machine-readable error code. |
field | string | Optional | Public field path when the error is field-scoped. |
message | string | Required within parent | Human-readable error message. |
Create hire — response body — results results item next actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
code | string | Required within parent | Machine-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_id | string | Optional | Role id the caller should continue, when applicable. |
Delist listing — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation timestamp. |
draft_status | string | Optional | The current draft-cycle slot status. |
draft_version | Model | Optional | Expand Delist listing — response body — draft version |
draft_version_id | string | Optional | The current draft-cycle version ID. |
icon | string | Optional | The listing icon URL. |
listing_id | string | Optional | The listing ID. |
name | string | Optional | The listing name or display name. |
owner_company_id | string | Optional | The publisher company ID that owns this listing. |
published_or_delisted_version | Model | Optional | Expand Delist listing — response body — published or delisted version |
published_status | string | Optional | The current published slot status. |
published_version_id | string | Optional | The current published or delisted version ID. |
status | string | Optional | The listing lifecycle status. |
type | string | Optional | The listing app type. |
updated_at | string | Optional | Last update timestamp. |
Referenced models: Delist listing — response body — draft version, Delist listing — response body — published or delisted version
Delist listing — response body — draft version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current editable or review listing version. |
catalog_binding_id | string | Optional | The package ID tied to this listing. |
catalog_binding_version_id | string | Optional | The package version ID selected by this listing version. |
created_at | string | Optional | Creation timestamp. |
display_name | string | Optional | The display name for this version. |
id | string | Optional | The listing version ID. |
latest_submission_notes | string | Optional | The latest notes submitted for review. |
metadata | object | Optional | Listing metadata for this version. |
published_at | string | Optional | Publish timestamp. |
status | string | Optional | The lifecycle status for this version. |
updated_at | string | Optional | Last update timestamp. |
version_name | string | Optional | The publisher-visible version label. |
Delist listing — response body — published or delisted version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current published or delisted listing version. |
catalog_binding_id | string | Optional | The package ID tied to this listing. |
catalog_binding_version_id | string | Optional | The package version ID selected by this listing version. |
created_at | string | Optional | Creation timestamp. |
display_name | string | Optional | The display name for this version. |
id | string | Optional | The listing version ID. |
latest_submission_notes | string | Optional | The latest notes submitted for review. |
metadata | object | Optional | Listing metadata for this version. |
published_at | string | Optional | Publish timestamp. |
status | string | Optional | The lifecycle status for this version. |
updated_at | string | Optional | Last update timestamp. |
version_name | string | Optional | The publisher-visible version label. |
Deploy a metadata component package — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | Model | Optional | Expand Deploy a metadata component package — response body — error |
installations | array | Required within parent | Per-component deployment results. |
installations[] | Model | Each item | Expand Deploy a metadata component package — response body — installations item |
success | boolean | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A validation, dependency, permission, or deployment issue. Additional keys: allowed |
cause | JSON | Optional | |
cause (anyOf 1) | string | Alternative | Lower-level cause associated with the issue, when available. |
cause (anyOf 2) | null | Alternative | |
code | string | Required within parent | Stable machine-readable issue code. |
component_type | JSON | Optional | |
component_type (anyOf 1) | string | Alternative | Component type associated with the issue, when available. |
component_type (anyOf 2) | null | Alternative | |
message | string | Required within parent | Human-readable remediation message. |
Deploy a metadata component package — response body — installations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
identifier | object | Required within parent | Installed component identifier. Additional keys: allowed |
navigation_target | JSON | Optional | |
navigation_target (anyOf 1) | object | Alternative | Navigation target for the installed component, when available. |
navigation_target (anyOf 1).target_type | string | Required within parent | Type of UI target. |
navigation_target (anyOf 1).title | string | Required within parent | Display title for the navigation target. |
navigation_target (anyOf 1).url | string | Required within parent | Relative URL for the installed component. |
navigation_target (anyOf 2) | null | Alternative | |
result | object | Optional | Type-specific install result. Additional keys: allowed |
status | string | Required within parent | Per-component install result. Known values: SUCCESS, FAILED, SKIPPED_ALREADY_EXISTS, UPDATED, SKIPPED_NO_CHANGES |
type | string | Required within parent | Metadata component type. |
Deploy an agent source revision — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
source_revision_id | string | Required within parent | The ID of the source revision to deploy |
Evaluate a leave program evaluation — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
birth_type | string | Optional | Optional 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_date | string | Optional | Optional date the child entered the family for bonding leave programs. |
claim_end_date | string | Optional | Optional requested leave end date. When set, leave_plan.pay_periods includes estimated per-paycheck amounts for programs that publish pay rates. |
claim_start_date | string | Required within parent | Requested leave start date. |
evidence_override | object | Optional | Demo/test-company only evidence overrides for exercising eligibility scenarios when the role's real data would not qualify. |
leave_reason | string | Required within parent | Normalized leave reason to evaluate against statutory and custom leave programs. One of: BONDING, PREGNANCY_DISABILITY, PREGNANCY_ACCOMMODATION, MEDICAL, VACATION, OTHER |
parental_leave_type | string | Optional | Optional 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_codes | array | Optional | Optional leave program codes to evaluate. When omitted, every registered leave program runs in dependency order. |
program_codes[] | string | Each item | |
role_id | string | Required within parent | Role ID for the employee whose leave request should be evaluated. |
supplemental_evidence | object | Optional | Answers 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_type | string | Optional | Accrual type to use when applying the adjustment. |
amount | string | Required within parent | Adjustment amount serialized as a decimal string. |
leave_type | string | Required within parent | Leave type to adjust if applying the evaluation. |
unit | string | Required within parent | Unit for the adjustment amount, such as WEEKS, DAYS, or HOURS. |
Evaluate a leave program evaluation — response body — leave plan coverage segments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | Segment end date, if known. |
program_codes | array | Required within parent | Programs active over this segment. |
program_codes[] | string | Each item | |
start_date | string | Required within parent | Segment start date. |
Evaluate a leave program evaluation — response body — leave plan earnings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Earning amount serialized as a decimal string. |
currency | string | Optional | ISO 4217 currency code for the earning amount. |
earning_type | string | Required within parent | Earning type to use if booking a payroll earning from the evaluation. |
weeks | string | Optional | Number of benefit weeks represented by this earning, serialized as a decimal string. |
Evaluate a leave program evaluation — response body — leave plan pay periods item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
carrier_total | object | Optional | Total estimated carrier-paid amount in this pay period. |
carrier_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
carrier_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
contributions | array | Required within parent | Estimated program-level pay slices in this pay period. |
contributions[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — leave plan pay periods item contributions item |
employer_total | object | Optional | Total estimated employer-paid amount in this pay period. |
employer_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
employer_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
government_total | object | Optional | Total estimated government-paid amount in this pay period. |
government_total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
government_total.currency | string | Required within parent | ISO 4217 currency code for the amount. |
period_end | string | Required within parent | Estimated pay period end date. |
period_start | string | Required within parent | Estimated pay period start date. |
total | object | Optional | Total estimated amount in this pay period. |
total.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
total.currency | string | Required within parent | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | object | Required within parent | Estimated amount for this program slice. |
amount.amount | string | Required within parent | Decimal monetary amount serialized as a string. |
amount.currency | string | Required within parent | ISO 4217 currency code for the amount. |
pay_source | string | Required within parent | Who pays the employee for this program slice. Known values: GOVERNMENT, CARRIER, EMPLOYER |
program_code | string | Required within parent | Program contributing pay in this pay period. |
Evaluate a leave program evaluation — response body — leave plan program contributions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | Program placement end date, if known. |
leave_type | string | Optional | Leave type associated with this program placement. |
leave_type_label | string | Optional | Human-readable leave type label. |
pay_status | string | Required within parent | Whether this program has an estimated pay rate. Known values: NOT_APPLICABLE, ESTIMATED |
program_code | string | Required within parent | Leave program code active on this claim window. |
start_date | string | Required within parent | Program placement start date. |
Evaluate a leave program evaluation — response body — missing evidence item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer_type | string | Required within parent | Expected answer type for this evidence key. |
key | string | Required within parent | Stable evidence key that can be supplied in supplemental_evidence. |
label | string | Required within parent | Human-readable label for the missing evidence. |
program_codes | array | Required within parent | Leave program codes that reported this missing evidence. |
program_codes[] | string | Each item |
Evaluate a leave program evaluation — response body — program results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
components | array | Optional | Legacy explanatory components for this program. |
components[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item components item |
directives | Model | Optional | Expand Evaluate a leave program evaluation — response body — program results item directives |
eligibility | string | Required within parent | Derived eligibility status for this program. Known values: eligible, ineligible, partially_eligible |
entitlement | object | Optional | Time entitlement for this program, if any. |
entitlement.amount | string | Required within parent | Entitlement amount serialized as a decimal string. |
entitlement.leave_type | string | Required within parent | Leave type associated with the entitlement. |
entitlement.unit | string | Required within parent | Unit for the entitlement amount, such as WEEKS, DAYS, or HOURS. |
gaps | array | Required within parent | UNKNOWN evidence keys to fix before eligibility can be fully resolved. |
gaps[] | string | Each item | |
is_payable | boolean | Required within parent | Whether the result is eligible and not blocked by payment-blocking requirements. |
job_protection | object | Optional | Job-protection details for this program, if any. |
job_protection.continues_group_health | boolean | Optional | Whether the program continues group health coverage. |
job_protection.restoration | string | Required within parent | Job-restoration right provided by the program. |
pay_rate | object | Optional | Estimated wage-replacement rate for this program, if any. |
pay_rate.phases | array | Required within parent | Wage-replacement phases for the program. |
pay_rate.phases[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item pay rate phases item |
pay_source | string | Optional | Who pays the employee for this program's wage-replacement slice. Known values: GOVERNMENT, CARRIER, EMPLOYER |
pay_summary | string | Optional | Human-readable pay summary for this program. |
program_code | string | Required within parent | Leave program code evaluated by the rules engine. |
program_requirements | array | Optional | Outstanding artifacts or actions for this program. |
program_requirements[] | Model | Each item | Expand Evaluate a leave program evaluation — response body — program results item program requirements item |
program_validations | array | Required within parent | Eligibility and assumption validations run for this program. |
program_validations[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | object | Optional | Additional component-specific data. |
kind | string | Required within parent | Category of explanatory result component. Known values: ELIGIBILITY, PAY, TIME, OTHER |
subkind | string | Optional | Optional machine-readable subtype for the component. |
summary | string | Required within parent | Human-readable summary for this component. |