List brands
Paginated list of the team's brands, oldest first. The default brand (`is_default: true`) applies to every link and dataroom that does not pin another brand.
Authorization
bearerAuth branding.readDashboard-issued token (pm_live_...) or OAuth-issued access token.
In: header
Scope: branding.read
Query Parameters
251 <= value <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.papermark.com/v1/brands"{
"data": [
{
"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"
}
],
"next_cursor": "string"
}{
"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": "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
}
}Upload a dataroom branding image
Upload an image for the dataroom's custom branding as the raw request body. The dataroom must be in `custom` mode; switch with PATCH /v1/datarooms/{id}/branding `{ "mode": "custom" }` first. To set an image from a public URL instead, PATCH with `{ "mode": "custom", "logo": { "source_url": "https://…" } }`.
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.