Branding

Update customize settings

Changes a site's branding; fields left out keep their value and a sent list replaces the stored one. Requires the admin scope; every update rebuilds the site.

PATCH

/sites/{site_id}/settings/customize

cURL

curl --request PATCH \
  --url 'https://api.notiondesk.so/sites/{site_id}/settings/customize' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "colors": {
    "primary": "string",
    "text": "string",
    "link": "string",
    "link_hover": "string",
    "header": "string",
    "header_top": "string",
    "header_text": "string",
    "header_top_text": "string",
    "header_link": "string",
    "header_link_hover": "string",
    "background": "string",
    "footer_background": "string",
    "footer_text": "string",
    "article_card_background": "string",
    "collection_card_background": "string",
    "aside_menu_text": "string",
    "aside_menu_text_hover": "string",
    "aside_menu_background_hover": "string",
    "dark": null
  },
  "appearance": {
    "default": "light",
    "strict": false
  },
  "layout_collection": "column_1",
  "layout_article": "column_1",
  "primary_font": "string",
  "secondary_font": "string",
  "header_variant": "hero",
  "headline_size": "small",
  "header_background_type": "color",
  "header_gradient_type": "linear",
  "header_gradient_angle": 0,
  "header_gradient_colors": [
    {
      "color": "string",
      "position": 0
    }
  ],
  "header_shape_type": "none",
  "header_links": [
    {
      "title": "string",
      "url": "string"
    }
  ],
  "header_link_translations": [
    {
      "locale": "string",
      "links": [
        {
          "title": "string",
          "url": "string"
        }
      ]
    }
  ],
  "homepage_link": "string",
  "homepage_link_translations": [
    {
      "locale": "string",
      "value": "string"
    }
  ],
  "search_bar_length": "short",
  "search_bar_alignment": "left",
  "search_bar_corner_style": "square",
  "search_bar_shadow": "none",
  "search_result_variant": "card",
  "instant_search": false,
  "segmented_search_results": false,
  "ai_search_enabled": false,
  "ai_search_display_mode": "modal",
  "ai_search_aside_position": "left",
  "collections_style": "standard",
  "collection_card_corner_style": "square",
  "collection_section_variant": "card",
  "collection_content_variant": "card",
  "collapsable_sub_categories": false,
  "collapsable_sub_categories_default_state": "collapsed",
  "show_collection_icons": false,
  "show_collection_descriptions": false,
  "show_collection_content": false,
  "show_collection_authors": false,
  "show_collection_articles_count": false,
  "articles_style": "standard",
  "article_card_corner_style": "square",
  "content_tabs_style": "underline",
  "article_footer_variant": "standard",
  "table_of_contents_position": "sidebar_left",
  "show_table_of_contents": false,
  "show_article_icons": false,
  "show_article_descriptions": false,
  "show_article_authors": false,
  "show_related_articles": false,
  "show_breadcrumb_icon": false,
  "show_article_publish_date": false,
  "show_article_page_author": false,
  "show_article_feedback_form": false,
  "require_email_for_article_feedback": false,
  "feedback_reaction_style": "emoji",
  "feedback_question_label": "page",
  "feedback_comment_mode": "optional",
  "aside_menu_expansion_mode": "static",
  "show_aside_menu_article_icons": false,
  "show_aside_menu_collection_icons": false,
  "footer_layout": "compact",
  "footer_shape_type": "none",
  "footer_links": [
    {
      "title": "string",
      "links": [
        {
          "title": "string",
          "url": "string"
        }
      ]
    }
  ],
  "footer_link_translations": [
    {
      "locale": "string",
      "groups": [
        {
          "title": "string",
          "links": [
            {
              "title": "string",
              "url": "string"
            }
          ]
        }
      ]
    }
  ],
  "footer_text_translations": [
    {
      "locale": "string",
      "value": "string"
    }
  ],
  "social_media_links": [
    {
      "title": "string",
      "url": "string"
    }
  ],
  "social_link_translations": [
    {
      "locale": "string",
      "links": [
        {
          "title": "string",
          "url": "string"
        }
      ]
    }
  ],
  "show_contact_us_button": false,
  "contact_us_custom_link": "string",
  "contact_us_button_position": "header",
  "show_powered_by_badge": false,
  "theme": "string"
}'

Authorizations

Authorizationstringheader
api_key · http · bearer
admin
Authorizationstringheader
oauth · oauth2
admin

Path parameters

site_idstringrequired
The id of a site from List sites.

Headers

nd-versionstring
The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.
Idempotency-Keystring
Makes a write safe to retry: the same key and body replay the first response with X-Idempotent-Replay: true. A different body answers 422 idempotency_key_reused; keys last at least 24 hours.

Body

application/jsonrequired

colorsobject | null
The site colours. A colour you leave out keeps its value, and null leaves them unchanged.
- primarystring
- textstring
- linkstring
- link_hoverstring
- headerstring
- header_topstring
- header_textstring
- header_top_textstring
- header_linkstring
- header_link_hoverstring
- backgroundstring
- footer_backgroundstring
- footer_textstring
- article_card_backgroundstring
- collection_card_backgroundstring
- aside_menu_textstring
- aside_menu_text_hoverstring
- aside_menu_background_hoverstring
- dark
appearanceobject | null
The colour mode readers get. null leaves it unchanged.
- defaultstring | null
- strictboolean
layout_collectionstring
layout_articlestring
primary_fontstring | null
secondary_fontstring | null
header_variantstring | null
headline_sizestring | null
header_background_typestring | null
header_gradient_typestring | null
header_gradient_angleinteger | null
header_gradient_colorsobject[]
- colorstring
  A #rrggbb hexadecimal colour.
- positioninteger | null
header_shape_typestring | null
Advanced customization.
header_linksobject[]
- titlestring | null
- urlstring | null
header_link_translationsobject[]
- localestring | null
- linksobject[]
  titlestring | null
  urlstring | null
homepage_linkstring | null
homepage_link_translationsobject[]
- localestring | null
- valuestring | null
search_bar_lengthstring
search_bar_alignmentstring
search_bar_corner_stylestring
search_bar_shadowstring | null
search_result_variantstring | null
instant_searchboolean
Advanced customization.
segmented_search_resultsboolean
Advanced customization.
ai_search_enabledboolean
ai_search_display_modestring | null
Advanced customization.
ai_search_aside_positionstring | null
Advanced customization.
collections_stylestring
collection_card_corner_stylestring
collection_section_variantstring | null
collection_content_variantstring | null
collapsable_sub_categoriesboolean
collapsable_sub_categories_default_statestring
show_collection_iconsboolean
show_collection_descriptionsboolean
show_collection_contentboolean
show_collection_authorsboolean
show_collection_articles_countboolean
articles_stylestring
article_card_corner_stylestring
content_tabs_stylestring | null
null leaves it unchanged.
article_footer_variantstring | null
table_of_contents_positionstring
show_table_of_contentsboolean
show_article_iconsboolean
show_article_descriptionsboolean
show_article_authorsboolean
show_related_articlesboolean
show_breadcrumb_iconboolean | null
null for a site that never set it.
show_article_publish_dateboolean
Advanced customization.
show_article_page_authorboolean
Advanced customization.
show_article_feedback_formboolean | null
Advanced customization. null for a site that never set it.
require_email_for_article_feedbackboolean | null
Advanced customization. null for a site that never set it.
feedback_reaction_stylestring | null
Advanced customization.
feedback_question_labelstring | null
Advanced customization.
feedback_comment_modestring | null
Advanced customization.
aside_menu_expansion_modestring | null
Advanced customization.
show_aside_menu_article_iconsboolean
Advanced customization.
show_aside_menu_collection_iconsboolean
Advanced customization.
footer_layoutstring
Advanced customization.
footer_shape_typestring | null
Advanced customization.
footer_linksobject[]
Advanced customization.
- titlestring | null
- linksobject[]
  titlestring | null
  urlstring | null
footer_link_translationsobject[]
Advanced customization.
- localestring | null
- groupsobject[]
  titlestring | null
  linksobject[]
  titlestring | null
  urlstring | null
footer_text_translationsobject[]
Advanced customization.
- localestring | null
- valuestring | null
social_media_linksobject[]
Advanced customization.
- titlestring | null
- urlstring | null
social_link_translationsobject[]
Advanced customization.
- localestring | null
- linksobject[]
  titlestring | null
  urlstring | null
show_contact_us_buttonboolean
Advanced customization. While it is true, every update turns the site's contact form on.
contact_us_custom_linkstring | null
Advanced customization.
contact_us_button_positionstring | null
Advanced customization.
show_powered_by_badgeboolean
Remove branding.
themestring | null
The code of a theme from List themes. null leaves the theme unchanged. Advanced customization.

Responses

Done. The body is empty. A replay with the same Idempotency-Key also answers 204 with an empty body.

Headers

nd-versionstring
The contract version that answered the request.
X-Idempotent-Replaystring
true when the response replays an earlier request sent with the same Idempotency-Key, otherwise false.
X-RateLimit-Limitinteger
Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.
X-RateLimit-Remaininginteger
Requests left in the current window.
Retry-Afterinteger
Seconds until the next request is accepted; 0 while requests remain.