Edit Website Images
website.edit_imagesAdds, replaces, or removes hosted images on an existing Carryo website without replacing its HTML. Reusing a path replaces that image without consuming another image slot; new paths are subject to the website image allowance. Returns hosted-image metadata and URLs. New paths appear in the page when referenced by its HTML. 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | |
| 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. | |
| removeAssetPaths | No | Optional relative asset paths to remove from the page asset bundle. |
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 | |
| assetUrls | No | URLs for added or replaced assets | |
| updatedAt | No | ISO-8601 update timestamp | |
| currentVersionNumber | No | ||
| publicationPerformed | No |