Rippling: Update a site — request body — body
Update a site: request body, field body. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Update a site — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for create/PATCH using a staged upload file_id. |
api_name | string | Optional | The unique api name of the custom site |
description | string | Optional | The optional description of the custom site |
entry_path | string | Optional | Entry path inside the uploaded asset (for example index.html). Required with file_id when the zip has no index.html. |
file_id | string | Optional | Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required to create a site or replace the bundle. 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. |
logo | string | Optional | A Rippling-owned logo URL for the custom site |
name | string | Optional | The display name of the custom site |