> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tied.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update notification settings

> Replaces the selected flags. Both arrays are set wholesale rather than merged, so send the complete list you want — and an empty array to turn that channel off entirely. A key you omit is set to empty, not left alone.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/accounts/{account_id}/notification_settings
openapi: 3.0.4
info:
  title: Tied API
  description: >-
    The Tied REST API. Three families of endpoint, each with its own credential:
    **Application** for everything inside an account, **Platform** for
    provisioning accounts and users, and **Client** for acting as a contact from
    your own surface.
  version: 1.1.0
  termsOfService: https://tied.com/legal
  contact:
    email: hello@tied.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://app.tied.com
    description: Tied cloud
security: []
tags:
  - name: Account AgentBots
    description: Account-specific Agent Bots
  - name: Agents
    description: Agent management APIs
  - name: Canned Responses
    description: Pre-defined responses for common queries
  - name: Contacts
    description: Contact management APIs
  - name: Contact Labels
    description: Manage contact labels
  - name: Conversation Assignments
    description: Manage conversation assignments
  - name: Conversation Labels
    description: Manage conversation labels
  - name: Conversations
    description: Conversation management APIs
  - name: Custom Attributes
    description: Custom fields for contacts and conversations
  - name: Custom Filters
    description: Saved filters for conversations
  - name: Inboxes
    description: Communication channels setup
  - name: Integrations
    description: Third-party integrations
  - name: Messages
    description: Message management APIs
  - name: Profile
    description: User profile APIs
  - name: Reports
    description: Analytics and reporting APIs
  - name: Teams
    description: Team management APIs
  - name: Webhooks
    description: Event notification webhooks
  - name: Automation Rule
    description: Workflow automation rules
  - name: Help Center
    description: Knowledge base management
  - name: Contacts API
    description: Public contact APIs
  - name: Conversations API
    description: Public conversation APIs
  - name: Messages API
    description: Public message APIs
  - name: CSAT Survey Page
    description: Customer satisfaction survey
  - name: Account
    description: >-
      The authenticated user's own account — read and update account settings.
      Distinct from the Platform family's **Accounts**, which provisions
      accounts across an installation.
  - name: Audit Logs
    description: Read the account's audit trail
  - name: Inbox API
    description: Public inbox lookup by channel identifier
  - name: Labels
    description: >-
      Create and manage the account's labels. Applying one to a conversation or
      contact is a separate endpoint under those resources.
  - name: Macros
    description: >-
      Saved multi-step actions an agent — or an integration — can run against
      one or more conversations.
  - name: Campaigns
    description: Ongoing website campaigns and one-off SMS and WhatsApp sends.
  - name: Contact Notes
    description: Internal notes on a contact. Never visible to the contact.
  - name: Help Center Categories
    description: Categories group a portal's articles, one tree per allowed locale.
  - name: Help Center Articles
    description: The articles a portal publishes, and their draft and archived states.
  - name: Summary Reports
    description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON.
  - name: Live Reports
    description: Right-now queue counts. No date range — these describe the present.
  - name: CSAT
    description: >-
      The satisfaction ratings contacts have submitted, and the metrics computed
      from them.
  - name: Notifications
    description: >-
      The per-user notification feed, its read and snooze state, and the
      settings that decide what lands in it.
  - name: Conversation Participants
    description: >-
      The agents watching a conversation. Participants get notified about it
      without being assigned to it.
  - name: Draft Messages
    description: >-
      The unsent reply held for a conversation. Stored in Redis, one per
      conversation.
  - name: Search
    description: >-
      One search service across conversations, contacts, messages and Help
      Center articles.
  - name: Dashboard Apps
    description: Embedded pages that appear as a tab beside a conversation.
  - name: Assignment Policies
    description: How conversations are handed out, and which inbox uses which policy.
  - name: Files
    description: Storing a file so another endpoint can attach it.
  - name: Bot Flows
    description: >-
      Scripted conversation flows, their versions, and the publish and rollback
      that move between them.
  - name: Billing
    description: >-
      Credit balance, usage, invoices, spend controls and the provider-hosted
      payment flows.
  - name: AMB Templates
    description: >-
      Saved Apple Messages primitive payloads an agent can reuse from the
      composer.
  - name: AMB Onboarding
    description: The in-flight Apple Messages for Business registration for an account.
  - name: Widget Session
    description: Starting a widget session and reading the visitor it belongs to.
  - name: Widget Conversation
    description: The visitor's conversation and its messages.
  - name: Widget Context
    description: Campaigns, agents, labels, events and uploads for a widget session.
  - name: CSAT Survey
    description: The public, unauthenticated survey a contact answers from a link.
  - name: Workspace
    description: Scheduling and cancelling deletion of the whole workspace.
paths:
  /api/v1/accounts/{account_id}/notification_settings:
    parameters:
      - $ref: '#/components/parameters/account_id'
    patch:
      tags:
        - Notifications
      summary: Update notification settings
      description: >-
        Replaces the selected flags. Both arrays are set wholesale rather than
        merged, so send the complete list you want — and an empty array to turn
        that channel off entirely. A key you omit is set to empty, not left
        alone.
      operationId: update-notification-settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notification_settings_update_payload'
            example:
              notification_settings:
                selected_email_flags:
                  - email_conversation_assignment
                  - email_conversation_mention
                selected_push_flags:
                  - push_conversation_assignment
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notification_settings'
              example:
                id: 1
                user_id: 1
                account_id: 1
                all_email_flags:
                  - email_conversation_creation
                  - email_conversation_assignment
                selected_email_flags:
                  - email_conversation_assignment
                  - email_conversation_mention
                all_push_flags:
                  - push_conversation_creation
                  - push_conversation_assignment
                selected_push_flags:
                  - push_conversation_assignment
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_validation'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: id
      schema:
        type: integer
      required: true
      description: The numeric ID of the account
  schemas:
    notification_settings_update_payload:
      type: object
      required:
        - notification_settings
      properties:
        notification_settings:
          type: object
          properties:
            selected_email_flags:
              type: array
              items:
                type: string
              description: >-
                The complete set of email flags to turn on. This replaces the
                current selection rather than adding to it, so send an empty
                array to turn email off entirely.
            selected_push_flags:
              type: array
              items:
                type: string
              description: >-
                The complete set of push flags to turn on. Replaces the current
                selection.
          description: The complete set of flags to turn on.
    notification_settings:
      type: object
      description: >-
        Which notification events this user receives by email and by push, for
        one account.
      properties:
        id:
          type: integer
          description: The numeric ID of the settings record.
        user_id:
          type: integer
          description: The user the settings belong to.
        account_id:
          type: integer
          description: >-
            The account they apply to. A user in several accounts has one record
            per account.
        all_email_flags:
          type: array
          items:
            type: string
          description: Every email flag that exists — the menu of what you may select.
        selected_email_flags:
          type: array
          items:
            type: string
          description: The email flags currently on.
        all_push_flags:
          type: array
          items:
            type: string
          description: Every push flag that exists.
        selected_push_flags:
          type: array
          items:
            type: string
          description: The push flags currently on.
    error_message:
      type: object
      description: >-
        The shape returned by `render_unauthorized`, `render_not_found_error`
        and `render_could_not_create_error`.
      properties:
        error:
          type: string
          description: A single human-readable message.
          example: Resource could not be found
      required:
        - error
    error_validation:
      type: object
      description: >-
        The shape returned by `render_record_invalid` when a model validation
        fails.
      properties:
        message:
          type: string
          description: The record's full error messages, comma-joined.
          example: Url has already been taken
        attributes:
          type: array
          description: The attributes that failed validation.
          items:
            type: string
          example:
            - url
      required:
        - message
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        This token can be obtained by visiting the profile page or via rails
        console. Provides access to  endpoints based on the user permissions
        levels. This token can be saved by an external system when user is
        created via API, to perform activities on behalf of the user.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.