Update branding — Brigg developers

Access & visibility

Allow workspace.UpdateBranding on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

profile_mdstring or nullOptional

Workspace company profile in Markdown. Omit to keep the current profile; null or an empty string clears it.

logo_urlstring or nullOptional

Image data URL to replace the public workspace logo. Omit to keep it; null clears it. This is an image upload, not a private-file attachment.

icon_urlstring or nullOptional

Image data URL to replace the public workspace icon. Omit to keep it; null clears it.

Response

Returns 200 OK with a JSON body.

okbooleanRequired

Whether the action completed successfully.

logo_urlnull or stringOptional

Absolute URL of the saved public logo, or null when cleared. Omitted when the logo was not changed.

icon_urlnull or stringOptional

Absolute URL of the saved public icon, or null when cleared. Omitted when the icon was not changed.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
502	`logo_store_failed`	The supplied logo could not be stored; check its image data URL.
502	`icon_store_failed`	The supplied icon could not be stored; check its image data URL.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "profile_md": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 40000,
          "description": "Workspace company profile in Markdown. Omit to keep the current profile; null or an empty string clears it."
        },
        {
          "type": "null",
          "description": "Workspace company profile in Markdown. Omit to keep the current profile; null or an empty string clears it."
        }
      ],
      "description": "Workspace company profile in Markdown. Omit to keep the current profile; null or an empty string clears it."
    },
    "logo_url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000000,
          "description": "Image data URL to replace the public workspace logo. Omit to keep it; null clears it. This is an image upload, not a private-file attachment."
        },
        {
          "type": "null",
          "description": "Image data URL to replace the public workspace logo. Omit to keep it; null clears it. This is an image upload, not a private-file attachment."
        }
      ],
      "description": "Image data URL to replace the public workspace logo. Omit to keep it; null clears it. This is an image upload, not a private-file attachment."
    },
    "icon_url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000000,
          "description": "Image data URL to replace the public workspace icon. Omit to keep it; null clears it."
        },
        {
          "type": "null",
          "description": "Image data URL to replace the public workspace icon. Omit to keep it; null clears it."
        }
      ],
      "description": "Image data URL to replace the public workspace icon. Omit to keep it; null clears it."
    }
  },
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "logo_url": {
      "description": "Absolute URL of the saved public logo, or null when cleared. Omitted when the logo was not changed.",
      "title": "OpenAdThreadSubtaskAgent_phase",
      "anyOf": [
        {
          "type": "null",
          "description": "Absolute URL of the saved public logo, or null when cleared. Omitted when the logo was not changed."
        },
        {
          "type": "string",
          "description": "Absolute URL of the saved public logo, or null when cleared. Omitted when the logo was not changed."
        }
      ]
    },
    "icon_url": {
      "description": "Absolute URL of the saved public icon, or null when cleared. Omitted when the icon was not changed.",
      "title": "OpenAdThreadSubtaskAgent_phase",
      "anyOf": [
        {
          "type": "null",
          "description": "Absolute URL of the saved public icon, or null when cleared. Omitted when the icon was not changed."
        },
        {
          "type": "string",
          "description": "Absolute URL of the saved public icon, or null when cleared. Omitted when the icon was not changed."
        }
      ]
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdateBranding' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdateBranding", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdateBranding",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.UpdateBranding' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.UpdateBranding", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.UpdateBranding",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true
}

Illustrative values, not a live response.