Edit a Live Website
website.editReplaces the complete HTML of an existing Carryo website while preserving its linkId and URL. Suitable for updating, fixing, or republishing a known page. Returns the website link and a Carryo management link. Access and edit limits are checked for the website identified by linkId. expectedVersionNumber detects conflicting edits. Supports adding or replacing hosted images and removing paths through removeAssetPaths. Image assets use relative HTML paths and exactly one source: a fileId matching a host-supplied imageFiles attachment, or a fetchable HTTP(S) sourceUrl. Carryo imports and hosts its own copy. Base64 image bytes and data URLs are unsupported. Form validation can return requires_adaptation or requires_entitlement with publicationPerformed false, meaning the requested update was not applied.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| forms | No | Optional definitions for JavaScript/React forms using window.CarryoForms.submit(key, values), which resolves on acceptance and rejects on failure. Stable keys and field names identify forms across edits. Static collection forms are inferred from data-carryo-form="key" and named controls without duplicate definitions; placeholder submit handlers can block collection. Local calculator/filter forms use data-carryo-local and do not collect responses. Existing external endpoints retain their destination. Visitor acknowledgement is disabled unless explicitly enabled. | |
| assets | No | Optional image assets to add or replace. Each entry requires a relative HTML path and exactly one of fileId (matching imageFiles[].file_id) or sourceUrl (a fetchable HTTP(S) image URL). Existing images are preserved when omitted. The hosted-image allowance applies to the final website collection; replacing an existing path does not use another slot. Base64 bytes and data URLs are unsupported. | |
| linkId | Yes | Carryo page link identifier to update | |
| fileName | No | Optional replacement file name | |
| expiresAt | No | Optional ISO-8601 expiration timestamp | |
| imageFiles | No | Optional image attachments supplied by a compatible host, with file_id and download_url. Each attachment is mapped to a relative HTML path by an assets entry with the matching fileId. Temporary download URLs are import sources, not hosted image URLs. Clients without file input support can omit this field. | |
| htmlContent | Yes | Updated complete HTML for the Carryo page while keeping the same URL. | |
| sharingMode | No | Optional replacement publishing mode. Only public live links are supported here. | |
| removeAssetPaths | No | Optional relative asset paths to remove from the page asset bundle. | |
| expectedVersionNumber | No | Expected current website version number for detecting conflicting edits. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| forms | No | ||
| linkId | No | Carryo page link identifier | |
| status | No | ||
| message | No | ||
| guidance | No | ||
| shareUrl | No | Primary share URL | |
| expiresAt | No | Optional ISO-8601 expiration timestamp | |
| manageUrl | No | Carryo web-app URL for managing the link URL, password, views, and edit history | |
| updatedAt | No | ISO-8601 update timestamp | |
| workspaceId | No | Workspace that owns the link; omitted for Personal | |
| alternateShareUrls | No | Alternate share URLs, when available | |
| currentVersionNumber | No | ||
| publicationPerformed | No |