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

# PublicApiCampaignAction

> POST /api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/actions/{action}

Use this endpoint through the Developer API or the matching `firstsales` CLI command when available. Responses use the stable FirstSales public error envelope.


## OpenAPI

````yaml POST /api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/actions/{action}
openapi: 3.1.0
info:
  title: FirstSales Developer API
  version: 1.0.0
  description: >-
    Public v1 developer API for FirstSales.io. Generated from live step
    definitions — do not hand-edit.
servers:
  - url: https://sandbox.api.app.firstsales.io
  - url: https://api.app.firstsales.io
security:
  - bearerAuth: []
tags:
  - name: Activities
  - name: Alerts
  - name: API Keys
  - name: Authentication
  - name: Billing
  - name: Blocked Domains
  - name: Campaigns
  - name: Companies
  - name: Connectors
  - name: Contacts
  - name: Copilot
  - name: Dashboard
  - name: Deals
  - name: Direct Email
  - name: Email Authentication
  - name: Inbox
  - name: Knowledge Bases
  - name: Learning
  - name: Offerings
  - name: Organizations
  - name: Product Updates
  - name: Sequence Library
  - name: Signals
    description: >-
      Beta. Find people who comment on or react to LinkedIn posts by a keyword,
      a person or a company page. Each scan costs 10x the scraper cost in
      credits (1 credit = $0.01), capped by the daily budget of the signal. A
      scan that adds no new person is free.
  - name: Suppression
  - name: Team
  - name: Tracking Domains
  - name: Warmup
paths:
  /api/v1/organizations/{orgId}/workspaces/{wsId}/campaigns/{campaignId}/actions/{action}:
    post:
      tags:
        - Campaigns
      summary: PublicApiCampaignAction
      operationId: runCampaignAction
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
        - name: wsId
          in: path
          required: true
          schema:
            type: string
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
        - name: action
          in: path
          required: true
          schema:
            type: string
            enum:
              - start
              - pause
              - resume
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartCampaignActionRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartCampaignActionSuccessResponse'
        '400':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '401':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '403':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '404':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '409':
          description: Launch pending, unknown, or blocked response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartCampaignActionConflictResponse'
        '429':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '500':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
      security:
        - developerKeyBearer: []
components:
  schemas:
    StartCampaignActionRequest:
      type: object
      properties:
        savedVersionId:
          type: string
          minLength: 1
        readinessVersion:
          type: string
          minLength: 1
        idempotencyKey:
          type: string
          minLength: 1
          maxLength: 200
        confirmation:
          type: object
          properties:
            token:
              type: string
              minLength: 1
            senderConnectorIds:
              type: array
              items:
                type: string
                minLength: 1
            eligibleAudienceCount:
              type: number
            timezone:
              type: string
              minLength: 1
            sendWindowStart:
              type: string
              minLength: 1
            sendWindowEnd:
              type: string
              minLength: 1
            activeDays:
              type: array
              items:
                type: string
                minLength: 1
            creditEstimateMin:
              type: number
            creditEstimateMax:
              type: number
            safeguards:
              type: array
              items:
                type: string
                minLength: 1
            consequence:
              type: string
              minLength: 1
            testOverride:
              type: boolean
          additionalProperties: false
      required:
        - savedVersionId
        - readinessVersion
        - idempotencyKey
        - confirmation
      additionalProperties: false
    StartCampaignActionSuccessResponse:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        outcome:
          type: string
          enum:
            - LAUNCHED
            - ALREADY_LAUNCHED
        consequence:
          type: string
          minLength: 1
        replayed:
          type: boolean
        attempt:
          $ref: '#/components/schemas/StartCampaignActionAttempt'
        receiptId:
          type: string
          minLength: 1
          maxLength: 200
          pattern: ^[A-Za-z0-9:_-]+$
        summary:
          type: object
          properties:
            liveStatus:
              type: string
              minLength: 1
            audience:
              type: object
              properties:
                eligibleCount:
                  type: number
              required:
                - eligibleCount
              additionalProperties: false
            schedule:
              type: object
              properties:
                timezone:
                  type: string
                  minLength: 1
                sendWindowStart:
                  type: string
                  minLength: 1
                sendWindowEnd:
                  type: string
                  minLength: 1
                activeDays:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
              required:
                - timezone
                - sendWindowStart
                - sendWindowEnd
                - activeDays
              additionalProperties: false
            safeguards:
              type: array
              items:
                type: string
                minLength: 1
            creditEstimate:
              type: object
              properties:
                min:
                  type: number
                max:
                  type: number
              required:
                - min
                - max
              additionalProperties: false
            testOverrideUsed:
              type: boolean
            nextExecutionAt:
              type:
                - string
                - 'null'
              format: date-time
            nextAction:
              type: object
              properties:
                key:
                  type: string
                  minLength: 1
                label:
                  type: string
                  minLength: 1
                consequence:
                  type: string
                  minLength: 1
              required:
                - key
                - label
                - consequence
              additionalProperties: false
            availableActions:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    minLength: 1
                  label:
                    type: string
                    minLength: 1
                  consequence:
                    type: string
                    minLength: 1
                  permitted:
                    type: boolean
                required:
                  - key
                  - label
                  - consequence
                  - permitted
                additionalProperties: false
          required:
            - liveStatus
            - audience
            - schedule
            - safeguards
            - creditEstimate
            - testOverrideUsed
            - nextExecutionAt
            - nextAction
            - availableActions
          additionalProperties: false
      required:
        - operationId
        - outcome
        - consequence
        - replayed
      additionalProperties: false
    PublicErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
            - requestId
      required:
        - error
    StartCampaignActionConflictResponse:
      type: object
      properties:
        operationId:
          type: string
          minLength: 1
          maxLength: 200
        outcome:
          type: string
          enum:
            - STALE_READINESS
            - ENTITLEMENT_CHANGED
            - TEST_OVERRIDE_REQUIRED
            - LAUNCH_UNKNOWN
            - LAUNCH_FAILED
            - LAUNCH_PENDING
        consequence:
          type: string
          minLength: 1
        replayed:
          type: boolean
        attempt:
          $ref: '#/components/schemas/StartCampaignActionAttempt'
        receiptId:
          type: string
          minLength: 1
          maxLength: 200
          pattern: ^[A-Za-z0-9:_-]+$
        summary:
          type: object
          properties:
            liveStatus:
              type: string
              minLength: 1
            audience:
              type: object
              properties:
                eligibleCount:
                  type: number
              required:
                - eligibleCount
              additionalProperties: false
            schedule:
              type: object
              properties:
                timezone:
                  type: string
                  minLength: 1
                sendWindowStart:
                  type: string
                  minLength: 1
                sendWindowEnd:
                  type: string
                  minLength: 1
                activeDays:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
              required:
                - timezone
                - sendWindowStart
                - sendWindowEnd
                - activeDays
              additionalProperties: false
            safeguards:
              type: array
              items:
                type: string
                minLength: 1
            creditEstimate:
              type: object
              properties:
                min:
                  type: number
                max:
                  type: number
              required:
                - min
                - max
              additionalProperties: false
            testOverrideUsed:
              type: boolean
            nextExecutionAt:
              type:
                - string
                - 'null'
              format: date-time
            nextAction:
              type: object
              properties:
                key:
                  type: string
                  minLength: 1
                label:
                  type: string
                  minLength: 1
                consequence:
                  type: string
                  minLength: 1
              required:
                - key
                - label
                - consequence
              additionalProperties: false
            availableActions:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    minLength: 1
                  label:
                    type: string
                    minLength: 1
                  consequence:
                    type: string
                    minLength: 1
                  permitted:
                    type: boolean
                required:
                  - key
                  - label
                  - consequence
                  - permitted
                additionalProperties: false
          required:
            - liveStatus
            - audience
            - schedule
            - safeguards
            - creditEstimate
            - testOverrideUsed
            - nextExecutionAt
            - nextAction
            - availableActions
          additionalProperties: false
      required:
        - operationId
        - outcome
        - consequence
        - replayed
      additionalProperties: false
    StartCampaignActionAttempt:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 200
        status:
          type: string
          minLength: 1
          maxLength: 100
        failureCode:
          type: string
          minLength: 1
          maxLength: 100
        testOverrideUsed:
          type: boolean
      required:
        - id
        - status
        - testOverrideUsed
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Legacy compatibility bearer scheme for generated consumers.
    developerKeyBearer:
      type: http
      scheme: bearer
      description: FirstSales developer API key bearer token (fs-key-*).

````

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