SHshareout
Artifacts

Edit artifact files

Changed on

Change an artifact with small operations instead of re-publishing every file. The ops run in order on the newest version, which base_version must name; if any op fails nothing is written. The result is published as the next version through the normal publish pipeline (moderation, tests gate, readiness), and files the ops leave unchanged are carried over without re-uploading. Counts once against the daily publish limit (dry_run does not). Requires the editor role. Works on html, markdown, csv, txt and json artifacts. Workspace Agent tokens need artifacts:publish and reach only artifacts in their own workspace. Renaming or deleting the mobile entrypoint turns the artifact's mobile view off. Send Idempotency-Key to make retries safe.

post/v1/artifacts/{id}/edits

Request

  • Base URL
    https://shareout.site
  • URL
    https://shareout.site/v1/artifacts/{id}/edits
  • Auth
    HTTP bearer

Request body

base_versioninteger required

The version_no of the files you read; must be the newest version.

messagestring

Note for the version history.

dry_runboolean

Report changes without saving anything.

Response

dry_run: true ({dry_run, base_version, would_create_version, entrypoint, changes}), or ops that leave every file as it was ({unchanged: true}): no version is created.

dry_runboolean
unchangedboolean
base_versioninteger
would_create_versioninteger

Changes