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

# Resume agent

> Lets a paused agent reply again.



## OpenAPI

````yaml /openapi.json post /agents/{agentId}/resume
openapi: 3.1.0
info:
  title: ReachHunt API
  version: 1.0.0
  description: >-
    The ReachHunt API gives your own apps and scripts programmatic access to
    your workspace: accounts, campaigns, lead lists, conversations, messages,
    tags and statuses.


    Send your API key in the `Authorization` header: `Authorization: Bearer
    YOUR_API_KEY`. The key decides the workspace, so no path or parameter names
    one.


    Every response has the same envelope: `{ "status": true, "data": ...,
    "error": null }`.
servers:
  - url: https://api.reachhunt.ai/api/v1
    description: Production
security: []
tags:
  - name: Workspaces
    description: Your workspace and the people in it.
  - name: Accounts
    description: The X and LinkedIn accounts you connected.
  - name: Analytics
    description: Activity over time.
  - name: Credits
    description: AI credits and how they were used.
  - name: Campaigns
    description: Outreach that messages your leads step by step.
  - name: Agents
    description: AI agents that reply to your leads.
  - name: Tags
    description: Labels you put on conversations.
  - name: Statuses
    description: Pipeline stages you put conversations in.
  - name: Leads
    description: The people in your lead lists.
  - name: Lead lists
    description: Lists of people you collect to message.
  - name: Conversations
    description: The conversations in your inbox.
  - name: Messages
    description: The messages in a conversation.
  - name: Conversation details
    description: Your team's record of the person in a conversation.
  - name: Internal notes
    description: Notes only your team sees.
  - name: Scheduled messages
    description: Messages set to send later.
  - name: Templates
    description: Saved messages you can reuse.
  - name: Webhook events
    description: What each event sends.
paths:
  /agents/{agentId}/resume:
    post:
      tags:
        - Agents
      summary: Resume agent
      description: Lets a paused agent reply again.
      operationId: agents.resume
      parameters:
        - name: agentId
          in: path
          required: true
          description: The agent ID.
          schema:
            type: string
      responses:
        '200':
          description: 'OK. Check `status`: errors the API handles itself also return 200.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                  - error
                properties:
                  status:
                    type: boolean
                    description: '`true` when the request succeeded.'
                  data:
                    type: object
                    required:
                      - agent
                    properties:
                      agent:
                        $ref: '#/components/schemas/Agent'
                  error:
                    type: 'null'
                    description: Always `null` on success.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    Agent:
      type: object
      description: An AI agent that replies to leads for you.
      additionalProperties: true
      required:
        - id
        - name
        - status
        - hasUnpublishedChanges
        - accountIds
        - campaignIds
        - model
        - companyName
        - version
        - publishedAt
        - updatedAt
        - stats
      properties:
        id:
          type: string
          description: The agent ID.
        name:
          type: string
          description: The agent name.
        status:
          type: string
          enum:
            - draft
            - live
            - paused
          description: >-
            `live` replies to leads, `paused` is on hold, `draft` was never
            published.
        hasUnpublishedChanges:
          type: boolean
          description: Whether it has edits that are not live yet.
        accountIds:
          type: array
          items:
            type: string
          description: The accounts it replies on.
        campaignIds:
          type: array
          items:
            type: string
          description: The campaigns that use it.
        model:
          type:
            - string
            - 'null'
          description: The AI model it uses.
        companyName:
          type:
            - string
            - 'null'
          description: The company it speaks for.
        version:
          type: integer
          description: The published version.
        publishedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When it was last published, in ISO 8601 UTC.
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When it last changed, in ISO 8601 UTC.
        stats:
          type: object
          description: What it has done.
          properties:
            messages:
              type: integer
              description: Messages it sent.
            activeUsers:
              type: integer
              description: People it is talking to.
            handoffs:
              type: integer
              description: Conversations it handed to a person.
    Failure:
      type: object
      required:
        - status
        - data
        - error
      properties:
        status:
          type: boolean
          description: Always `false` for an error.
        data:
          type: 'null'
          description: Always `null` for an error.
        error:
          type: string
          description: What went wrong, in plain words.
  responses:
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Not authenticated
    PlanRequired:
      description: The workspace has no active plan, or its trial has ended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Your free trial has ended. Pick a plan to continue.
    ServerError:
      description: Something failed on our side. Try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
          example:
            status: false
            data: null
            error: Something went wrong. Please try again.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer
      description: >-
        Your API key, sent as `Authorization: Bearer YOUR_API_KEY`. Create one
        in **Settings → API**.
      x-default: Bearer YOUR_API_KEY

````

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