brands

A brand is a named set of viewer settings: logo, banner, colors, welcome message and call to action, data room layout, and the preview card a shared link unfurls into. The team's default brand applies to every data room and link that does not pin another brand or carry its own custom branding. The full model, with the three per-room modes, is in the guide Brand a data room.

$ papermark brands create --name "Acme" --brand-color '#0f172a' --logo ./logo.png --default
✓ Brand created: clxbrand1234567890
{
  "id": "clxbrand1234567890",
  "object": "brand",
  "name": "Acme",
  "is_default": true,
  "logo_url": "https://…/branding/team_…/logo-abc123.png",
  ...
}

list

papermark brands list [--limit <n>] [--cursor <id>]

$ papermark brands list
ID                    NAME       DEFAULT  COLOR    LOGO  CREATED
clxbrand1234567890    Acme       yes      #0f172a  yes   2026-09-23
clxbrand0987654321    Acme Fund           #1d4ed8        2026-09-23

Brands come back oldest first.

get

papermark brands get <id>

Prints the brand as JSON: every color, image URL, layout, and preview field.

create

papermark brands create --name <name> [--default] [branding flags]

Plus any of the branding flags below. The team's first brand becomes the default even without --default.

Image flags that point at a local file are uploaded one PUT per image after the brand is created, in the order you passed them. An https:// URL is sent in the create body instead, and Papermark downloads it.

papermark brands create \
  --name "Acme Fund" \
  --brand-color '#1d4ed8' \
  --accent-color '#ffffff' \
  --logo https://acme.com/brand/logo.png \
  --banner ./fund-banner.png \
  --welcome-message "Welcome to the Acme Fund data room"

update

papermark brands update <id> [--name <name>] [--default] [branding flags]

Patches the brand. Omitted flags stay unchanged; pass "" to clear a nullable field or remove an image. At least one flag is required. An update that only carries local image files skips the PATCH and goes straight to the image uploads.

# Swap the logo, keep everything else
papermark brands update clxbrand1234567890 --logo ./new-logo.png

# Hide the banner on this brand, clear the welcome message
papermark brands update clxbrand1234567890 --banner hidden --welcome-message ""

delete

papermark brands delete <id>

Deletes the brand and its images. Data rooms and links pinned to it fall back to the team default. Deleting the default brand promotes the oldest remaining brand to default. Rooms in custom mode are unaffected.

Branding flags

The same flags work on brands create, brands update, and datarooms branding set --mode custom. Each flag is named after the API field. Pass "" to clear a nullable field.

Fields

Setting a field back to its default value is never plan-gated. Enum values are accepted in any case and uppercased.

Images

Each image flag takes a local file path, an https:// URL, or "" to remove the image.

The CLI checks local files before sending anything: the extension must be one of the accepted ones (the content type comes from the extension), the file must be non-empty, and it must be under the slot's cap. Non-https URLs are rejected. No SVG or WebP.

With --dry-run, a binary request body is summarized as <N bytes image/png from ./logo.png> instead of printed, and brands create shows the upload against the placeholder id :id because no brand exists yet.

Required scopes

papermark login requests both by default. A session created before these scopes existed needs a fresh papermark login.

Related

• datarooms branding: choose which brand a data room shows, or give it custom branding
• Guide: Brand a data room: the model and the worked recipe across CLI, API, and MCP
• API: Branding: the endpoints behind these commands
• MCP: Branding tools: the same surface for agent-driven workflows