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

# Take a live call off hold

> States the wanted state rather than toggling. uuid_hold toggles by default, which is the wrong shape for an API: two clients disagreeing about the current state would flip it back and forth. Requires calls:control.



## OpenAPI

````yaml /api-reference/openapi-public.json post /calls/{uuid}/unhold
openapi: 3.0.3
info:
  description: >-
    The API your own systems use: place and follow calls, have an AI agent call
    someone, run campaigns and get their results, keep contacts in step with
    your CRM, and receive signed webhooks. Authenticate with an integration key
    (Authorization: Bearer ft_...), used only from the IP addresses it allows.
  title: FireTone API
  version: 0.1.0
servers:
  - description: Your platform's API host
    url: https://{host}/api/v1
    variables:
      host:
        default: api.firet.one
security:
  - bearerAuth: []
tags:
  - name: Auth
  - description: >-
      Live calls and what can be done to them: hang up, hold, transfer, park,
      merge, monitor, whisper; the Desk's own call.
    name: Calls
  - description: 'Outbound campaigns: contacts, attempts, outcomes.'
    name: Campaigns
  - description: 'Customers: who called, what is known about them, and their memory.'
    name: Contacts
  - description: What was said on an AI call, and the review of it.
    name: Conversations
  - description: >-
      Your own systems: HTTP connections an IVR calls mid-call, and webhooks for
      call events. Tenant URLs must be public https addresses.
    name: Integrations
  - name: Live
  - name: Provisioning
  - name: Reporting
  - description: Tickets raised by people, agents and the API.
    name: Tickets
  - description: Messages left for an extension or a queue.
    name: Voicemail
paths:
  /calls/{uuid}/unhold:
    post:
      tags:
        - Live
      summary: Take a live call off hold
      description: >-
        States the wanted state rather than toggling. uuid_hold toggles by
        default, which is the wrong shape for an API: two clients disagreeing
        about the current state would flip it back and forth. Requires
        calls:control.
      operationId: postCallsUuidUnhold
      parameters:
        - in: path
          name: uuid
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '204':
          description: Taken off hold
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            No such call, or not one you may act on. An agent may act only on a
            call they are on; a colleague's call returns this same 404, so the
            refusal cannot be used to discover who is talking to whom.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The switch refused
components:
  responses:
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Outside the caller's scope, or insufficient role
  schemas:
    Error:
      properties:
        error:
          properties:
            code:
              enum:
                - invalid_request
                - invalid_credentials
                - unauthenticated
                - forbidden
                - not_found
                - conflict
                - internal
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT or API key
      description: >-
        Every request sends `Authorization: Bearer <token>`. The token is either
        a panel session (a JWT from /auth/login, 12 hours) or an API key
        `ft_<id>_<secret>`. An API key is accepted only from an address on its
        IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required
        for an old key that has none), is limited to its rate per minute (429
        rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on
        every response), and at most 60 call placements a minute.
      scheme: bearer
      type: http

````