Rippling: Create hire — request body — body hires item employment modern award
Create hire: request body, field body / hires / item / employment / modern_award. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: 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 |