Set the organisation logo

Admin only. Points the organisation settings at a logo that was already uploaded to storage. The key sits under the branding prefix at 2 MB or less, and a missing settings row is created.

PUT/api/v1/images/branding/logo

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

image_keystringrequired

min length 1

Responses

200

The logo key and its public URL

logo_keystringrequired

logo_urlstringrequired

400

The image key is not under the branding prefix, or the upload is missing or larger than 2 MB

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

500

Image storage is unavailable

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

image_keystring*

Request

curl -X PUT 'http://localhost:8000/api/v1/images/branding/logo' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "image_key": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/images/branding/logo", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"image_key\": \"string\"\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/images/branding/logo",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"image_key\": \"string\"\n}",
)

Response

{
  "logo_key": "string",
  "logo_url": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}