---
title: "Save an Inbox installation"
method: PUT
path: "/integrations/inbox/installations"
tags: ["inbox"]
---

# Save an Inbox installation

`PUT /integrations/inbox/installations`

Creates a new installation of a Inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.

## Request body

- InboxConfigPayload
  - `images` object, nullable, required — Image overrides for assets used in the inbox UI.
    - `emptyInboxUrl` string, required — URL for the illustration shown when the inbox is empty.
  - `locale` string, nullable, required — Locale code (ISO language tag) used to localize built-in strings.
  - `theme` object, nullable, required — Visual customization options for the hosted inbox widget.
    - `banner` object — Top banner styling options.
      - `backgroundColor` string, required — Banner background color.
      - `backgroundOpacity` number — Opacity applied to the banner background.
      - `fontSize` string, required — Font size for banner text.
      - `textColor` string, required — Banner text color.
    - `dialog` object — Styling for confirmation and action dialogs.
      - `accentColor` string, required — Accent color for dialog buttons and highlights.
      - `backgroundColor` string, required — Dialog background color.
      - `textColor` string, required — Dialog text color.
    - `footer` object — Footer styling for the inbox modal.
      - `backgroundColor` string, required — Footer background color.
      - `borderRadius` string, required — Border radius applied to the footer container.
      - `fontSize` string, required — Font size used in the footer.
      - `textColor` string, required — Footer text color.
    - `header` object — Header styling for the inbox modal.
      - `backgroundColor` string, required — Header background color.
      - `borderRadius` string, required — Border radius applied to the header container.
      - `fontFamily` string, required — CSS font family for the header title.
      - `fontSize` string, required — Font size used in the header.
      - `textColor` string, required — Header text color.
    - `icon` object — Launcher icon styling overrides.
      - `borderColor` string, required — CSS color used for the icon border.
      - `width` string, required — Width of the launcher icon (any CSS length).
    - `notification` object — Styling overrides for notification list items.
      - `default` object, required — Base styles applied to every notification item.
        - `backgroundColor` string, required — Background color for notifications in their default state.
        - `borderRadius` string, required — Border radius applied to each notification card.
        - `fontFamily` string, required — Font family for notification text.
        - `fontSize` string, required — Font size for notification text.
        - `hover` object — Styles applied when a notification is hovered.
          - `backgroundColor` string, required — Background color on hover.
        - `margin` string, required — CSS margin applied around each notification card.
        - `state` object — Accent colors for notification state indicators.
          - `color` string, required — Color used for the state indicator.
        - `textColor` string, required — Default text color for notifications.
      - `unread` object, required — Overrides for unread notifications.
        - `backgroundColor` string, required — Background color applied to unread notifications.
        - `hover` object — Hover styles for unread notifications.
          - `backgroundColor` string, required — Background color on hover for unread notifications.
        - `state` object — State indicator styling for unread notifications.
          - `color` string, required — Color for the unread state indicator.
        - `textColor` string, required — Text color used when a notification is unread.
      - `unseen` object, required — Overrides for unseen notifications.
        - `backgroundColor` string, required — Background color applied to unseen notifications.
        - `hover` object — Hover styles for unseen notifications.
          - `backgroundColor` string, required — Background color on hover for unseen notifications.
        - `state` object — State indicator styling for unseen notifications.
          - `color` string, required — Color for the unseen state indicator.
        - `textColor` string, required — Text color used when a notification is unseen.
    - `unseenBadge` object — Badge styling for unseen notification counts.
      - `backgroundColor` string, required — Badge background color.

## Response `200`

OK

- InboxConfigPayload
  - `images` object, nullable, required — Image overrides for assets used in the inbox UI.
    - `emptyInboxUrl` string, required — URL for the illustration shown when the inbox is empty.
  - `locale` string, nullable, required — Locale code (ISO language tag) used to localize built-in strings.
  - `theme` object, nullable, required — Visual customization options for the hosted inbox widget.
    - `banner` object — Top banner styling options.
      - `backgroundColor` string, required — Banner background color.
      - `backgroundOpacity` number — Opacity applied to the banner background.
      - `fontSize` string, required — Font size for banner text.
      - `textColor` string, required — Banner text color.
    - `dialog` object — Styling for confirmation and action dialogs.
      - `accentColor` string, required — Accent color for dialog buttons and highlights.
      - `backgroundColor` string, required — Dialog background color.
      - `textColor` string, required — Dialog text color.
    - `footer` object — Footer styling for the inbox modal.
      - `backgroundColor` string, required — Footer background color.
      - `borderRadius` string, required — Border radius applied to the footer container.
      - `fontSize` string, required — Font size used in the footer.
      - `textColor` string, required — Footer text color.
    - `header` object — Header styling for the inbox modal.
      - `backgroundColor` string, required — Header background color.
      - `borderRadius` string, required — Border radius applied to the header container.
      - `fontFamily` string, required — CSS font family for the header title.
      - `fontSize` string, required — Font size used in the header.
      - `textColor` string, required — Header text color.
    - `icon` object — Launcher icon styling overrides.
      - `borderColor` string, required — CSS color used for the icon border.
      - `width` string, required — Width of the launcher icon (any CSS length).
    - `notification` object — Styling overrides for notification list items.
      - `default` object, required — Base styles applied to every notification item.
        - `backgroundColor` string, required — Background color for notifications in their default state.
        - `borderRadius` string, required — Border radius applied to each notification card.
        - `fontFamily` string, required — Font family for notification text.
        - `fontSize` string, required — Font size for notification text.
        - `hover` object — Styles applied when a notification is hovered.
          - `backgroundColor` string, required — Background color on hover.
        - `margin` string, required — CSS margin applied around each notification card.
        - `state` object — Accent colors for notification state indicators.
          - `color` string, required — Color used for the state indicator.
        - `textColor` string, required — Default text color for notifications.
      - `unread` object, required — Overrides for unread notifications.
        - `backgroundColor` string, required — Background color applied to unread notifications.
        - `hover` object — Hover styles for unread notifications.
          - `backgroundColor` string, required — Background color on hover for unread notifications.
        - `state` object — State indicator styling for unread notifications.
          - `color` string, required — Color for the unread state indicator.
        - `textColor` string, required — Text color used when a notification is unread.
      - `unseen` object, required — Overrides for unseen notifications.
        - `backgroundColor` string, required — Background color applied to unseen notifications.
        - `hover` object — Hover styles for unseen notifications.
          - `backgroundColor` string, required — Background color on hover for unseen notifications.
        - `state` object — State indicator styling for unseen notifications.
          - `color` string, required — Color for the unseen state indicator.
        - `textColor` string, required — Text color used when a notification is unseen.
    - `unseenBadge` object — Badge styling for unseen notification counts.
      - `backgroundColor` string, required — Badge background color.

---

[API](https://skmtc.net/magicbell/apis/magicbell-api.md) · [All operations](https://skmtc.net/magicbell/apis/magicbell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/magicbell/magicbell-api/revisions/8b99dca11019/schema)