Create a brand

Create a named team brand. The team's first brand becomes the default; pass `is_default: true` to make a later one the default. Images can be set here from a public `source_url`, or uploaded as raw bytes with PUT /v1/brands/{id}/images/{slot}. The number of brands is limited by plan.

Authorization

bearerAuth branding.write

AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: branding.write

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

brand_color?|

Match^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

accent_color?|

Match^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

accent_button_color?|

Match^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

apply_accent_color_to_dataroom_view?boolean

hide_logo?boolean

welcome_message?|

Requires a Business or Data Rooms plan. An empty string clears it.

Lengthlength <= 80

cta_label?|

Requires a Business or Data Rooms plan.

Lengthlength <= 80

cta_url?|

HTTPS URL for the call-to-action button. Requires a Business or Data Rooms plan. An empty string clears it.

Lengthlength <= 2048

card_layout?string

Requires a Data Rooms plan unless set to the default LIST.

Value in"GRID" | "LIST" | "COMPACT"

show_folder_tree?boolean

Requires a Data Rooms plan unless set to the default true.

viewer_layout_preset?string

Requires a Data Rooms plan unless set to the default STANDARD.

Value in"STANDARD" | "STRICT" | "MODERN" | "NOTION" | "CUSTOM"

viewer_header_style?string

Requires a Data Rooms plan unless set to the default DEFAULT.

Value in"DEFAULT" | "SPLIT" | "NOTION"

hide_folder_icons_in_main?boolean

Requires a Data Rooms plan unless set to the default false.

default_language?string

Viewer language (BCP-47) for the access screen and viewer chrome. Anything other than en requires a Data Rooms Plus plan.

Value in"en" | "de" | "fr" | "es" | "it" | "nl" | "pt-BR" | "ja"

custom_link_preview_enabled?boolean

Enabling requires a Business or Data Rooms plan.

link_preview_title?|

Lengthlength <= 120

link_preview_description?|

Lengthlength <= 240

logo?|

PNG or JPEG, up to 2 MB. Null removes the logo.

banner?||

{ source_url } sets a banner image, { hidden: true } hides the banner, null restores the Papermark default banner.

link_preview_image?|

PNG or JPEG, up to 4 MB (1200x630 recommended). Requires a Business or Data Rooms plan.

link_preview_favicon?|

PNG or ICO, up to 1 MB. Requires a Business or Data Rooms plan.

name*string

Unique within the team.

Length1 <= length <= 80

is_default?boolean

Make this the team's default brand. To change the default, set is_default: true on another brand.

Response Body

`application/json`

curl -X POST "https://api.papermark.com/v1/brands" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme"  }'

{
  "id": "clxbrand1234567890",
  "object": "brand",
  "name": "Default",
  "is_default": true,
  "logo_url": "string",
  "hide_logo": true,
  "banner_url": "string",
  "banner_hidden": true,
  "brand_color": "#0f172a",
  "accent_color": "#ffffff",
  "accent_button_color": "string",
  "apply_accent_color_to_dataroom_view": true,
  "welcome_message": "string",
  "cta_label": "string",
  "cta_url": "string",
  "card_layout": "GRID",
  "show_folder_tree": true,
  "viewer_layout_preset": "STANDARD",
  "viewer_header_style": "DEFAULT",
  "hide_folder_icons_in_main": true,
  "default_language": "en",
  "custom_link_preview_enabled": true,
  "link_preview_title": "string",
  "link_preview_description": "string",
  "link_preview_image_url": "string",
  "link_preview_favicon_url": "string",
  "created": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "bad_request",
    "message": "The request body is not valid JSON.",
    "doc_url": "https://www.papermark.com/docs/api/errors#bad_request",
    "details": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token. Include an `Authorization: Bearer <token>` header.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Token is missing required scope: links.write.",
    "doc_url": "https://www.papermark.com/docs/api/errors#forbidden",
    "details": null
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Link link_abcd1234 not found.",
    "doc_url": "https://www.papermark.com/docs/api/errors#not_found",
    "details": null
  }
}

{
  "error": {
    "code": "conflict",
    "message": "A resource with this identifier already exists.",
    "doc_url": "https://www.papermark.com/docs/api/errors#conflict",
    "details": null
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "Invalid request body.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unprocessable_entity",
    "details": {
      "formErrors": [],
      "fieldErrors": {
        "expires_at": [
          "Invalid datetime"
        ]
      }
    }
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 30s.",
    "doc_url": "https://www.papermark.com/docs/api/errors#rate_limit_exceeded",
    "details": null
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "An unexpected error occurred. Please try again.",
    "doc_url": "https://www.papermark.com/docs/api/errors#internal_server_error",
    "details": null
  }
}

Create a brand

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`