Configure an install
const url = 'https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/apps/facebook-capi/installs/8d7c6b5a-4938-4271-a605-9e8f7a6b5c4d/variables';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"values":{"PIXEL_ID":"1234567890"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/apps/facebook-capi/installs/8d7c6b5a-4938-4271-a605-9e8f7a6b5c4d/variables \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "values": { "PIXEL_ID": "1234567890" } }'Stores an installation’s configuration values — the settings the app declares in its manifest, including its secrets. Only the names in the body are written; anything left out keeps its current value.
How it works
A secret’s value is write-only and never returned by any operation. Completing the last required variable makes the install active, which redeploys the site in the background; a call that changes nothing does neither. An OAuth token’s user also needs an app role of admin or higher on the site.
Required permissions
domain:manage_domain_apps:writeon all domains, or on the addressed domain when its id is in the route
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.
Example
7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.
Unique id (UUID) of the site, as returned by the site operations.
Example
3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15Unique id (UUID) of the site, as returned by the site operations.
Immutable slug of the app, as shown by the list operation.
Example
facebook-capiImmutable slug of the app, as shown by the list operation.
Unique id (UUID) of the installation, as returned by the installs operation.
Example
8d7c6b5a-4938-4271-a605-9e8f7a6b5c4dUnique id (UUID) of the installation, as returned by the installs operation.
Request Bodyrequired
Section titled “Request Bodyrequired”The values to store, keyed by variable name.
The install’s configuration values. A secret variable’s value is write-only and never read back.
object
The values to store, keyed by the variable name the app declares. A boolean variable takes true/false; a select takes an option value, or an empty string for none; a multiselect takes a list of option values, or an empty list for none.
object
The value of a text, password or select variable.
Example
1234567890The value of a toggle variable.
Example
trueThe value of a multiselect variable: option values, stored in manifest order.
Example
[ "AddToCart", "Purchase"]Example
{ "PIXEL_ID": "1234567890"}Responses
Section titled “Responses”The values were stored.
object
Whether the switch actually changed.
Example
{ "updated": true}invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.
object
Example
{ "error": "invalid_params", "details": { "errors": [], "properties": { "teamId": { "errors": [ "Invalid UUID" ] } } }}unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "unauthenticated"}forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Human-readable reason for this specific failure, intended for display — do not parse it programmatically.
Example
{ "error": "forbidden", "message": "The Cloudflare API token is invalid or expired."}not_found — The addressed resource does not exist within this team; check the id and retry.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "not_found"}variable_invalid — The app declares no variable by that name, or another party sets the name (the site manager, the app developer, or the app’s own panel); message names it. variable_too_large — A value exceeds its serialized limit: 256 KB for a large variable, 5 KB for another variable of a single-install app, 490 bytes for one of an app that allows multiple installs or for an app-scope variable; message names the variable, its size and the limit. variable_budget — One variable’s values across every install of the app on this site exceed 5 KB together, or all large values of the app’s worker exceed 1 MB, removed installs included until they are purged; message states the size. Shorten a value before retrying; a removed install frees its share once it is purged.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Human-readable reason for this specific failure, intended for display — do not parse it programmatically.
Example
{ "error": "variable_invalid", "message": "The Cloudflare API token is invalid or expired."}internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "internal"}