TOtopi
ops
ops-branding

Update a branding config

Changed on

Update a branding config

put/ops/branding/{branding_id}

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/branding/{branding_id}
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-branding:edit

Path parameters

branding_idstring required

ID of the branding config to update

Example:abc123

Request body

Example request

{
  "branding": {
    "brand_values": {
      "focus_color": "abc123",
      "primary_color": "abc123",
      "primary_color_hover": "abc123",
      "primary_color_muted": "abc123",
      "primary_color_pressed": "abc123",
      "primary_color_tint": "abc123",
      "text_color_on_primary": "abc123",
      "text_size_scale": 1
    },
    "email_logo_url": "abc123",
    "enable_transactional_emails": false,
    "info_hub_url": "abc123",
    "logo_url": "abc123",
    "name": "abc123",
    "short_name": "abc123"
  }
}

Response

OK response.

created_atstring date-time required
email_logo_urlstring

Url for the logo to display in emails, if any

enable_transactional_emailsboolean required

Whether or not to enable transactional emails

idstring regexp required

ID of branding config

info_hub_urlstring

Url for the info hub, if any

logo_urlstring

Url for the logo to display, if any

namestring required

Name of the branding config

short_namestring

Short brand identifier (lowercase letters, digits and underscores) used to resolve brand assets

updated_atstring date-time required

Example response

{
  "brand_values": {
    "focus_color": "abc123",
    "primary_color": "abc123",
    "primary_color_hover": "abc123",
    "primary_color_muted": "abc123",
    "primary_color_pressed": "abc123",
    "primary_color_tint": "abc123",
    "text_color_on_primary": "abc123",
    "text_size_scale": 1
  },
  "created_at": "1970-01-01T00:00:01Z",
  "email_logo_url": "abc123",
  "enable_transactional_emails": false,
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "info_hub_url": "abc123",
  "logo_url": "abc123",
  "name": "abc123",
  "short_name": "abc123",
  "updated_at": "1970-01-01T00:00:01Z"
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id branding.updateBranding removed and replaced with branding#updateBranding

  • 7ff7ee94b30eRevision changes
    • info

      api operation id branding#updateBranding removed and replaced with branding.updateBranding

    • info

      api tag ops-branding added