Skip to content

Rippling: Create a presigned staged upload batch — response body — files item

Create a presigned staged upload batch: response body, field files / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a presigned staged upload batch — response body — files item

FieldTypePresenceDescription and constraints
$objectRoot
client_refstringOptionalAny unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.
file_idstringOptionalStaged upload identifier for use in create, update, or file operations after uploading bytes to S3. The id can be reused for 1 hour from presign, each attach copies the bytes into that site’s bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.
file_namestringOptionalStaged file name from the presign file_name intent.
statusstringOptionalUpload status. Returns awaiting_upload after presign until the file is uploaded to S3. After the object exists in S3, status becomes active on first use. Attach does not consume the staged upload; it is removed after expiry.
upload_fieldsobjectOptionalForm fields required for the S3 POST (send these before the file part).
upload_urlstringOptionalPresigned S3 POST URL for uploading the file bytes.

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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