Organization Branding

Overview

Organization branding is reusable organization-level data. It is not part of the document library and it is not tied to one report template.

Use these routes:

• GET /v1/orgs/{organizationId}/branding
• PUT /v1/orgs/{organizationId}/branding
• GET /v1/orgs/{organizationId}/branding/assets/{slot}
• POST /v1/orgs/{organizationId}/branding/assets/{slot}/upload-start
• POST /v1/orgs/{organizationId}/branding/assets/{slot}/upload-complete
• GET /v1/orgs/{organizationId}/branding/assets/{slot}/download
• DELETE /v1/orgs/{organizationId}/branding/assets/{slot}

Current fixed asset slots:

• logo
• banner

Metadatai have warnings with the Magick package i use. How do i fix them? Just use the newer version?

GET /v1/orgs/{organizationId}/branding returns the current branding record for the organization.

PUT /v1/orgs/{organizationId}/branding updates the fixed branding fields:

• brandName
• slogan
• primaryColor
• secondaryColor
• accentColor

Use null or an empty string to clear one of those values.

Assets

Branding assets are managed per slot.

1. Call upload-start for logo or banner.
2. Upload the file to the returned presigned URL.
3. Call upload-complete for the same slot.

The current file for a slot is available from GET /v1/orgs/{organizationId}/branding/assets/{slot}.

To fetch the file itself, call GET /v1/orgs/{organizationId}/branding/assets/{slot}/download.

Supported linkType values:

• file
• small
• medium

Use small or medium when you need a preview image.

Use DELETE /v1/orgs/{organizationId}/branding/assets/{slot} to remove the current file from that slot.

Permissions

Organization members can read branding.

Only organization owners and admins can update branding metadata or manage branding assets.

Reports

Report templates can read organization branding through the branding.* values that PixService provides at render time.

Typical examples:

• branding.brand_name
• branding.slogan
• branding.primary_color
• branding.logo_data_url
• branding.banner_data_url