> ## 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.

# Set automatic offline

> Controls whether Tied drops this user to offline on its own when they go idle, for one account membership. Sending no `auto_offline` key is treated as `false` rather than leaving the current value.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/profile/auto_offline
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/profile/auto_offline:
    post:
      tags:
        - Profile
      summary: Set automatic offline
      description: >-
        Controls whether Tied drops this user to offline on its own when they go
        idle, for one account membership. Sending no `auto_offline` key is
        treated as `false` rather than leaving the current value.
      operationId: set-profile-auto-offline
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/profile_auto_offline_payload'
            example:
              profile:
                account_id: 1
                auto_offline: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user'
              example:
                access_token: EXAMPLE_ACCESS_TOKEN
                account_id: 1
                available_name: Alex
                avatar_url: ''
                thumbnail: /dashboard/images/default-contact-avatars/031.svg
                illustration_avatar: true
                confirmed: true
                display_name: Alex
                message_signature: Alex · Tied Support
                email: you@example.com
                id: 1
                inviter_id: null
                name: Alex Rivera
                provider: email
                pubsub_token: EXAMPLE_PUBSUB_TOKEN
                role: administrator
                ui_settings:
                  illustration_avatar_index: 31
                uid: you@example.com
                type: null
                accounts:
                  - id: 1
                    name: Tied
                    status: active
                    active_at: '2026-09-19T21:15:37.761Z'
                    role: administrator
                    permissions:
                      - administrator
                    availability: busy
                    availability_status: busy
                    auto_offline: false
                    custom_role_id: null
                    custom_role: null
        '404':
          description: Not found
          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:
  schemas:
    profile_auto_offline_payload:
      type: object
      required:
        - profile
      properties:
        profile:
          type: object
          required:
            - account_id
          properties:
            account_id:
              type: integer
              description: Which account membership to set.
              example: 1
            auto_offline:
              type: boolean
              description: >-
                Whether Tied drops this user to offline automatically when they
                go idle. Omitting it is treated as `false`.
          description: Which membership to set, and whether automatic offline is on.
    user:
      type: object
      properties:
        id:
          type: number
          description: The numeric ID of the user.
        access_token:
          type: string
          description: >-
            The user's `userApiKey`. Treat it as a credential — anything holding
            it can do whatever this user can.
        account_id:
          type: number
          description: The account the response is scoped to.
        available_name:
          type: string
          description: >-
            What contacts see: the display name when one is set, otherwise the
            full name.
        avatar_url:
          type: string
          description: URL of an uploaded avatar. Empty when the user has not uploaded one.
        confirmed:
          type: boolean
          description: Whether the user has confirmed their email address.
        display_name:
          type: string
          nullable: true
          description: >-
            The name shown to contacts instead of the full name. Null when
            unset.
        message_signature:
          type: string
          nullable: true
          description: >-
            Appended to outgoing replies on inboxes with signatures enabled.
            Null when unset.
        email:
          type: string
          description: The user's email address, which is also their login.
        hmac_identifier:
          type: string
          description: Identifier used when computing identity verification hashes.
        inviter_id:
          type: number
          nullable: true
          description: The user who invited this one. Null for the account creator.
        name:
          type: string
          description: The user's full name.
        provider:
          type: string
          description: How the user signs in — `email` for a password login.
        pubsub_token:
          type: string
          description: >-
            Token for the realtime channel this user subscribes to. Treat it as
            a credential.
        role:
          type: string
          enum:
            - agent
            - administrator
          description: The role in the account this response is scoped to.
        ui_settings:
          type: object
          description: Dashboard preferences — sidebar state, chosen avatar, and similar.
        uid:
          type: string
          description: >-
            The unique identifier the auth provider knows the user by. The same
            as the email for a password login.
        type:
          type: string
          nullable: true
          description: Set for non-human users such as agent bots. Null for a person.
        custom_attributes:
          type: object
          description: >-
            Available for users who are created through platform APIs and has
            custom attributes associated.
        accounts:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
                description: The account ID.
              name:
                type: string
                description: The account name.
              status:
                type: string
                description: Whether the account is active or suspended.
              active_at:
                type: string
                format: date-time
                description: >-
                  When the user last used this account. Drives which account the
                  dashboard opens on.
              role:
                type: string
                enum:
                  - administrator
                  - agent
                description: The user's role in this account.
              permissions:
                type: array
                items:
                  type: string
                description: >-
                  The effective permissions, expanded from the role and any
                  custom role.
              availability:
                type: string
                description: The availability the user has chosen in this account.
              availability_status:
                type: string
                description: >-
                  The availability Tied computes, which automatic offline can
                  pull to `offline` regardless of the choice.
              auto_offline:
                type: boolean
                description: >-
                  Whether Tied drops this user offline automatically when they
                  go idle.
              custom_role_id:
                type: number
                nullable: true
                description: The custom role applied in this account, if any.
              custom_role:
                type: object
                nullable: true
                description: >-
                  The expanded custom role. Null when the user has only a
                  standard role.
          description: >-
            Every account this user belongs to, with their role and availability
            in each. A user can be an administrator in one and an agent in
            another.
        thumbnail:
          type: string
          description: Path or URL of the avatar shown in the dashboard.
        illustration_avatar:
          type: boolean
          description: >-
            Whether `thumbnail` is a generated illustration rather than an
            upload.
    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.