> ## 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 the routing profile

> Requires an administrator of the URL account and its `model_settings` feature. An authenticated member receives 404 when the feature is disabled. Account membership is checked before the feature and role; nonmembers receive 401. This controller reads and changes routing profiles only; it accepts no provider keys or model selections. Separate provider-key and routing APIs remain owned by ENG-4915/ENG-5860; ENG-5876 reconciles their contract with I-30. Accepts top-level profile and lock_version only (parameter wrapping is disabled). Missing or malformed inputs return 422 invalid_params. A stale version returns 409 stale before profile validation. An unchanged profile is a no-op after the lock check. A changed profile writes an account policy and audit event atomically. A pinned profile cannot be changed by customers. Unknown additional fields are ignored. Provider-key/model validation is not performed here.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/accounts/{account_id}/model_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.
  - name: Widget Integrations
    description: Provider actions available to a visitor session in its own conversation.
  - name: Orchestration Studio
    description: >-
      Administrator-only read APIs for Orchestration Studio cases and knowledge
      sources.
  - name: Topic Analytics
    description: Account Topics readiness, labeling health and usage aggregates.
  - name: Analytics V2
    description: >-
      Account-scoped metrics, anonymized benchmarks and audited conversation
      drilldown.
  - name: Knowledge proposals
    description: Administrator-only proposal review and revision decisions.
  - name: Model settings
    description: Administrator-only routing profiles and Tied-hosted catalogue.
paths:
  /api/v1/accounts/{account_id}/model_settings:
    patch:
      tags:
        - Model settings
      summary: Update the routing profile
      description: >-
        Requires an administrator of the URL account and its `model_settings`
        feature. An authenticated member receives 404 when the feature is
        disabled. Account membership is checked before the feature and role;
        nonmembers receive 401. This controller reads and changes routing
        profiles only; it accepts no provider keys or model selections. Separate
        provider-key and routing APIs remain owned by ENG-4915/ENG-5860;
        ENG-5876 reconciles their contract with I-30. Accepts top-level profile
        and lock_version only (parameter wrapping is disabled). Missing or
        malformed inputs return 422 invalid_params. A stale version returns 409
        stale before profile validation. An unchanged profile is a no-op after
        the lock check. A changed profile writes an account policy and audit
        event atomically. A pinned profile cannot be changed by customers.
        Unknown additional fields are ignored. Provider-key/model validation is
        not performed here.
      operationId: update-model-settings
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: integer
          description: Numeric account id; the authenticated caller must be a member.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/model_settings_update'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model_settings'
              example:
                profile:
                  key: balanced
                  label: Balanced
                  source: account
                plan_tier: none
                lock_version: 1
                profiles:
                  - key: lowest_cost
                    label: Lowest cost
                    description: >-
                      Picks the least expensive option that passes our quality
                      checks for each job.
                    available: false
                    refusal: plan_not_eligible
                  - key: fastest_resolution
                    label: Fastest resolution
                    description: >-
                      Picks the fastest option that passes our quality checks,
                      so customers get answers sooner.
                    available: false
                    refusal: plan_not_eligible
                  - key: highest_reasoning
                    label: Highest reasoning
                    description: >-
                      Picks the strongest reasoning option that passes our
                      quality checks. Costs more.
                    available: false
                    refusal: plan_not_eligible
                  - key: balanced
                    label: Balanced
                    description: Our recommended mix of cost, speed and quality.
                    available: true
                    refusal: null
                  - key: healthy_mix
                    label: Healthy mix
                    description: >-
                      A stronger reply for better answers. Costs more than
                      Balanced.
                    available: false
                    refusal: plan_not_eligible
                overrides: []
          x-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-default.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
          x-ignored-fields-example:
            profile:
              key: balanced
              label: Balanced
              source: account
            plan_tier: none
            lock_version: 1
            profiles:
              - key: lowest_cost
                label: Lowest cost
                description: >-
                  Picks the least expensive option that passes our quality
                  checks for each job.
                available: false
                refusal: plan_not_eligible
              - key: fastest_resolution
                label: Fastest resolution
                description: >-
                  Picks the fastest option that passes our quality checks, so
                  customers get answers sooner.
                available: false
                refusal: plan_not_eligible
              - key: highest_reasoning
                label: Highest reasoning
                description: >-
                  Picks the strongest reasoning option that passes our quality
                  checks. Costs more.
                available: false
                refusal: plan_not_eligible
              - key: balanced
                label: Balanced
                description: Our recommended mix of cost, speed and quality.
                available: true
                refusal: null
              - key: healthy_mix
                label: Healthy mix
                description: A stronger reply for better answers. Costs more than Balanced.
                available: false
                refusal: plan_not_eligible
            overrides: []
          x-ignored-fields-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-ignored-fields.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '400':
          description: Multiple credential types.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_credential_conflict'
          x-mixed-credentials-example:
            error:
              code: multiple_credentials
          x-mixed-credentials-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-mixed-credentials.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '401':
          description: Authentication or account membership required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orchestration_studio_unauthorized'
          x-foreign-account-example:
            error: You are not authorized to access this account
          x-foreign-account-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-foreign-account.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
          x-role-401-example:
            error: Access to this endpoint is not authorized for bots
          x-role-401-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-role-401.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '402':
          description: >-
            Account trial is expired and locked; writes are refused before
            feature and role checks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/knowledge_model_trial_lock'
          x-trial-locked-example:
            error: trial_expired_locked
            message: >-
              This workspace trial has ended. Restore billing from the billing
              page to continue.
          x-trial-locked-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-trial-locked.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '403':
          description: Administrator required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
          x-role-403-example:
            error: You are not authorized to do this action
          x-role-403-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-role-403.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '404':
          description: Feature disabled or record outside this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
          x-feature-off-example:
            error: Resource could not be found
          x-feature-off-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-feature-off.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '409':
          description: Stale lock_version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
          x-validation-0-example:
            error: stale
          x-validation-0-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-validation-0.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
        '422':
          description: Invalid input or validation refusal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model_settings_error'
          x-nested-envelope-example:
            error: invalid_params
          x-nested-envelope-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-nested-envelope.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
          x-validation-1-example:
            error: refused
            code: unknown_profile
            message: That profile does not exist.
          x-validation-1-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-validation-1.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
          x-validation-2-example:
            error: invalid_params
          x-validation-2-example-provenance:
            capture_file: >-
              docs/platform-api/knowledge-model-evidence/update-model-settings-validation-2.json
            content_type: application/json; charset=utf-8
            synthetic: true
            scrubbed: true
      security:
        - userApiKey: []
components:
  schemas:
    model_settings_update:
      type: object
      properties:
        profile:
          type: string
          description: Profile.
        lock_version:
          oneOf:
            - type: integer
              minimum: 0
              maximum: 2147483647
            - type: string
              pattern: ^[0-9]{1,10}$
              description: Decimal integer string, numeric value at most 2147483647.
          description: Lock version.
      required:
        - profile
        - lock_version
      additionalProperties: true
    model_settings:
      type: object
      properties:
        profile:
          type: object
          properties:
            key:
              type: string
              description: Key.
            label:
              type: string
              description: Label.
            source:
              type: string
              enum:
                - default
                - account
                - staff_pinned
              description: Source.
          required:
            - key
            - label
            - source
          additionalProperties: false
          description: Profile.
        plan_tier:
          type: string
          description: Plan tier.
        lock_version:
          type: integer
          description: Lock version.
        profiles:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Key.
              label:
                type: string
                description: Label.
              description:
                type: string
                description: Description.
              available:
                type: boolean
                description: Available.
              refusal:
                type: string
                nullable: true
                description: Refusal.
            required:
              - key
              - label
              - description
              - available
              - refusal
            additionalProperties: false
          description: Profiles.
        overrides:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                description: Role.
              job_group:
                type: string
                nullable: true
                description: Job group.
              set_by:
                type: string
                enum:
                  - tied
                description: Set by.
            required:
              - role
              - job_group
              - set_by
            additionalProperties: false
          description: Overrides.
      required:
        - profile
        - plan_tier
        - lock_version
        - profiles
        - overrides
      additionalProperties: false
    orchestration_studio_credential_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - multiple_credentials
              description: Conflicting credential types were supplied.
          required:
            - code
          description: The authentication error.
      required:
        - error
    orchestration_studio_unauthorized:
      description: >-
        Anonymous requests return errors; an outsider or account bot returns
        error.
      oneOf:
        - type: object
          properties:
            errors:
              type: array
              items:
                type: string
              description: Errors for this response.
          required:
            - errors
        - $ref: '#/components/schemas/error_message'
    knowledge_model_trial_lock:
      type: object
      properties:
        error:
          type: string
          description: Trial lock state.
          enum:
            - trial_expired_locked
        message:
          type: string
          description: Restore billing guidance.
      required:
        - error
        - message
      additionalProperties: false
    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
    model_settings_error:
      oneOf:
        - type: object
          properties:
            error:
              type: string
              enum:
                - invalid_params
          required:
            - error
          additionalProperties: false
        - $ref: '#/components/schemas/model_settings_refusal'
    model_settings_refusal:
      type: object
      properties:
        error:
          type: string
          enum:
            - refused
          description: Error.
        code:
          type: string
          enum:
            - unknown_profile
            - staff_only_profile
            - plan_not_eligible
            - not_in_tier_allowlist
            - golden_gate_unavailable
          description: Code.
        message:
          type: string
          description: Message.
      required:
        - error
        - code
        - message
      additionalProperties: false
  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.