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

# Archive campaign

> Archive a campaign. The campaign is hidden immediately and moved to ARCHIVED in the background (async — returns 202).



## OpenAPI

````yaml /openapi.json post /v1/campaigns/{id}/archive
openapi: 3.0.0
info:
  title: Botdog API
  description: |-
    API documentation for Botdog.

    **Authentication**: Pass your API key as the `x-api-key` header.
    Example: `x-api-key: bd_live_abc123`

    Do NOT use the `Authorization` header.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.botdog.co
    description: Production
security: []
tags:
  - name: campaigns
    description: >-
      Create, read, update, and control campaigns (pause/resume, pause
      activities, archive, delete).
  - name: leads
    description: >-
      List and filter leads, read full detail + event history, update metadata,
      add to a campaign, or stop a sequence.
  - name: lists
    description: Manage lead/audience lists and their members.
  - name: blacklist
    description: Manage suppression lists (excluded profiles).
  - name: snippets
    description: Manage message snippets / templates.
  - name: accounts
    description: >-
      Connected LinkedIn accounts (seats), their connection health, and daily
      sending limits.
  - name: webhooks
    description: Manage webhook subscriptions.
  - name: messaging
    description: >-
      Send messages and replies, schedule a future send, and mark conversations
      read/unread. Rate-limited per sending account.
  - name: analytics
    description: Team-level analytics totals, daily breakdowns, and per-user metrics.
  - name: users
    description: Read the users in your team.
  - name: teams
    description: Current team context.
  - name: health
    description: Service health checks (no authentication).
paths:
  /v1/campaigns/{id}/archive:
    post:
      tags:
        - campaigns
      summary: Archive campaign
      description: >-
        Archive a campaign. The campaign is hidden immediately and moved to
        ARCHIVED in the background (async — returns 202).
      operationId: CampaignsController_archive
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignAsyncOpResponseDto'
        '401':
          description: Unauthorized. API key is missing or invalid.
        '404':
          description: Campaign not found
        '429':
          description: Rate limit exceeded. Retry after cooldown.
      security:
        - api-key: []
components:
  schemas:
    CampaignAsyncOpResponseDto:
      type: object
      properties:
        campaignId:
          type: string
          description: The campaign identifier
        status:
          type: string
          description: >-
            The accepted async operation. The campaign is hidden immediately and
            removed/archived in the background.
          example: deletion_requested
          enum:
            - deletion_requested
            - archival_requested
      required:
        - campaignId
        - status
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      x-default: bd_live_your_key_here

````