Set the background image key

PUT

/api/v1/admin/appearance/unsplash-key

const url = 'https://example.com/api/v1/admin/appearance/unsplash-key';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"access_key":"example"}'
};

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://example.com/api/v1/admin/appearance/unsplash-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "access_key": "example" }'

Sets the background image key. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 400 if the request is invalid, 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/appearance/unsplash-key. Inputs: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Request Body^required

application/json

Empty access_key clears the stored secret.

object

access_key

required

string

Example^generated

{
  "access_key": "example"
}

Responses

200

application/json

The admin API exposes whether a key exists, never the key itself.

object

configured

required

boolean

Example^generated

{
  "configured": true
}

Set the background image key

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

400

403

Request Body^required

Example^generated

Example^generated