Rippling: Create a new employee document — response body — items item

API reference · Contract 2026-10-28

SDK schema: Create a new employee document — response body — items item

Field	Type	Presence	Description and constraints
$	object	Root	A single item: attach `documents` to the worker identified by `worker_id`.
documents	array	Required within parent	Documents to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.
documents[]	Model	Each item	Expand Create a new employee document — response body — items item documents item
folder_id	string	Optional	Optional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier (‘root’, ‘confidential_documents’, ‘notices’, ‘work_authorization’). When omitted, documents land at the root of the worker’s profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
on_invalid_folder	string	Optional	Fallback behavior when `folder_id` is supplied but inaccessible. ‘fail’ (default) rejects each affected document with FOLDER_ACCESS_ERROR. ‘fallback_to_root’ uploads to the worker’s root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted. Known values: fail, fallback_to_root
worker_id	string	Required within parent	Id of the worker to attach documents to.

Referenced models: Create a new employee document — response body — items item documents item