Create a branding logo upload URL

Admin only. Returns a presigned URL the console PUTs an organisation logo to. The key sits under the branding prefix and allows JPEG, PNG, or WebP logos of 2 MB or less.

POST/api/v1/images/branding/upload-url

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Request body

requiredapplication/json

content_typestringrequired

min length 1

size_bytesintegerrequired

max 9007199254740991

Responses

200

The presigned upload and the key it targets

keystringrequired

uploadUrlstringrequired

publicUrlstringrequired

400

The size is not a positive whole number, the content type is not JPEG, PNG, or WebP, or the logo is more than 2 MB

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

500

Image storage is not configured

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

content_typestring*size_bytesinteger*

Request

curl -X POST 'http://localhost:8000/api/v1/images/branding/upload-url' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "content_type": "string",
  "size_bytes": 1
}'

const response = await fetch("http://localhost:8000/api/v1/images/branding/upload-url", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"content_type\": \"string\",\n  \"size_bytes\": 1\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/images/branding/upload-url",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"content_type\": \"string\",\n  \"size_bytes\": 1\n}",
)

Response

{
  "key": "string",
  "uploadUrl": "string",
  "publicUrl": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}