Change an Environment's branding
/api/v1/brandingSets the Environment's branding. Every field is optional and stands on its own: send only what you want to change, send null to clear a field (the primary color then returns to the default blue). The product name shows in the browser tab, as the logo's alt text and in place of a missing logo; the logo shows at the top and the favicon in the tab; the primary color drives buttons and links, and the hover, link and focus shades are derived from it; the background color paints the page behind the card; the support, terms and privacy links show as "Need help?", "Terms" and "Privacy" under every hosted page. Returns 400 (validation) for a malformed value. Emits environment.branding_updated.
Authentication
Authorization Option A JWT access token. Never send alongside X-API-Key: a request carrying both is refused.
X-API-Key Option B API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.
branding.manageBrandingChange the Environment's hosted-page branding. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.
Headers
X-Canopy-EnvironmentThe id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).
Request body
application/json
product_namestring Optional The product name hosted pages and the organization admin portal show: in the browser tab title, beside the logo when `logo_kind` is `icon`, as a full logo's alt text, and in place of a logo when none is set. Null clears it, and the pages then show no name.
logo_urlstring Optional Absolute https URL of the logo shown at the top of hosted pages, the portal and emails to the Environment's users. Emails show it only when the image is a PNG, JPEG or GIF, which every email client displays; with any other format they show the product name. Null clears it.
logo_kindenum Optional What the logo image is. `full`: a complete logo that already carries the product name, shown alone. `icon`: a square mark, shown at icon size with the product name beside it. Null returns to `full`.
favicon_urlstring Optional Absolute https URL of the browser-tab icon on hosted pages: a square PNG or ICO of at least 32 px. Null clears it.
primary_colorstring Optional Six-digit hex colour for buttons and links on hosted pages and the portal. Hover, link, focus and tint shades are derived from it so each meets its contrast rule. Null returns to the default blue.
background_colorstring Optional Six-digit hex colour for the page behind the card on hosted pages. The card stays white; footer text is chosen to reach 4.5:1 against it. Null returns to the neutral grey.
support_urlstring Optional Where "Need help?" points: an https URL or a mailto: address. Null hides it.
terms_urlstring Optional Absolute https URL of the customer's terms, linked as "Terms" in the hosted pages' footer. Null hides it.
privacy_urlstring Optional Absolute https URL of the customer's privacy policy, linked as "Privacy" in the hosted pages' footer. Null hides it.
Responses
application/json
dataEnvironmentBrandingResponseDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
Errors
When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.
authorization.deniedForbiddenThe credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.
Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.
Returned object
curl -X PATCH "https://auth.canopy-io.com/api/v1/branding" \ -H "X-Canopy-Environment: value" \ -H "X-API-Key: $CANOPY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "product_name": "string", "logo_url": "string", "logo_kind": "full", "favicon_url": "string", "primary_color": "#B93C0C", "background_color": "#0B1F3A", "support_url": "string", "terms_url": "string", "privacy_url": "string" }'
{ "data": { "environment_slug": "string", "branding": { "product_name": "string", "logo_url": "string", "logo_kind": "full", "favicon_url": "string", "primary_color": "string", "background_color": "string", "support_url": "string", "terms_url": "string", "privacy_url": "string" }, "effective": { "product_name": "string", "logo_url": "string", "logo_kind": "full", "favicon_url": "string", "primary_color": "string", "background_color": "string", "support_url": "string", "terms_url": "string", "privacy_url": "string", "attribution": false }, "brand_removal_available": false } }
Tell us how we can improve this guide.