Update an installed copy to the template's latest version

POST

/v1/artifact-templates/installed/update

const url = 'https://shareout.site/v1/artifact-templates/installed/update';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"artifact_id":"example","confirm":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://shareout.site/v1/artifact-templates/installed/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "artifact_id": "example", "confirm": true }'

Without confirm returns the plan (files that change per artifact). With confirm true each artifact of the install gets a new version (source template); earlier versions stay in history and data is not touched.

Authorizations

bearerAuth

Request Body^required

application/json

object

artifact_id

required

string

confirm

boolean

Example^generated

{
  "artifact_id": "example",
  "confirm": true
}

Responses

200

{ applied: false, plan } or { applied: true, updated, added, version_no, setup }

403

Needs edit access to every artifact of the install

Update an installed copy to the template's latest version

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

403

Request Body^required

Example^generated