Skip to content

Rippling: Create a new file — request body — body

Create a new file: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a new file — request body — body

FieldTypePresenceDescription and constraints
$objectRootResponse DTO for “POST /files/“ and “GET /files/{id}“.
content_typestringOptionalMIME type supplied by the client at create time
display_namestringOptionalHuman-readable label for the file
statusstringRequired within parentLifecycle status: awaiting_upload | uploaded | active | infected
upload_fieldsobjectOptionalRequired form fields to include in the multipart POST to S3 alongside the file binary
upload_urlstringOptionalS3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.
url_dataobjectOptionalURLs for accessing the uploaded file after a successful upload
url_data.preview_urlstringOptionalCDN URL for previewing the uploaded file after upload completes
url_data.s3_urlstringOptionalS3 URL where the file is accessible after upload

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.