PUT /api/v1/business-units/{business_unit_uuid}/branding
Personal access token & O auth2

Update branding settings for a business unit. Scalar settings (colours, booleans, HTML) are sent as a settings array. File fields (logos, backgrounds) are sent as file uploads.

Path parameters

  • business_unit_uuid string Required
application/json

Body

  • settings array[object]

    List of scalar settings to update (colours, booleans, HTML). File fields must use dedicated upload fields.

    Hide settings attributes Show settings attributes object
    • key string

      The setting key (must be a valid PlannrSettingKey value).

    • value string

      The setting value.

  • logo_icon string(binary)

    Image file for the logo icon. Max 10 MB, 50–150px square, 1:1 ratio.

  • banner string(binary)

    Image file for the banner. Max 25 MB.

  • branded_auth_background string(binary)

    Image file for the branded auth background. Max 25 MB.
PUT /api/v1/business-units/{business_unit_uuid}/branding 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/business-units/6ff8f7f6-1eb3-3525-be4a-3932c805afed/branding' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"settings":[{"key":"sidebar_background","value":"#0E0E56"}],"logo":"file-contents","logo_icon":"file-contents","email_logo":"file-contents","banner":"file-contents","branded_auth_background":"file-contents"}'
Request examples 
{
  "settings": [
    {
      "key": "sidebar_background",
      "value": "#0E0E56"
    }
  ],
  "logo": "file-contents",
  "logo_icon": "file-contents",
  "email_logo": "file-contents",
  "banner": "file-contents",
  "branded_auth_background": "file-contents"
}