Change an Environment's branding

PATCH

/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/branding

Sets 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

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability env_branding.manageDeveloper Console

Change Environment branding. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

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.

max length 60

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`.

one of "full" · "icon"

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*

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.

403account.capability_requiredForbidden

When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

EnvironmentBrandingResponseDtoView all properties on this resource

Request

curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/branding" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -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"
  }'

Response

{
  "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
  }
}

GETList Environments in an Application
POSTCreate a new Environment in an Application
GETGet a single Environment by slug
PATCHRename or re-slug an Environment
DELETEDelete an Environment
GETGet an Environment's sign-in settings
PATCHChange an Environment's sign-in settings
GETGet an Environment's branding
GETExport an Environment's configuration as JSON
POSTReplace an Environment's configuration from a JSON payload (destructive)
GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off
GETGet hierarchy schema for the active Environment
PATCHUpdate hierarchy schema for the active Environment
GETList hierarchy node types with existing nodes
POSTRevert this Environment from hierarchy to flat

Was this page helpful?

Tell us how we can improve this guide.