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

# Update, pause, resume, schedule, or complete a campaign.



## OpenAPI

````yaml /openapi.json patch /v1/campaigns/{campaignId}
openapi: 3.1.0
info:
  title: Sigmora API
  version: 1.0.0
  description: >-
    The priced, versioned public API. Every call authenticates with a workspace
    API key (`Authorization: Bearer sk_live_…`), names the project it files its
    output under, and reports what it cost. `GET /v1/capabilities` answers what
    this deployment can serve right now and at what price; anything it reports
    as unavailable answers 503 `capability_unavailable` rather than 404.
servers:
  - url: https://api.sigmora.org
security:
  - bearerAuth: []
paths:
  /v1/campaigns/{campaignId}:
    patch:
      summary: Update, pause, resume, schedule, or complete a campaign.
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                  maxLength: 160
                description:
                  default: ''
                  type: string
                  maxLength: 4000
                connectedAccountIds:
                  default: []
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                platforms:
                  default: []
                  maxItems: 50
                  type: array
                  items:
                    type: string
                    enum:
                      - tiktok
                      - instagram
                      - youtube
                      - x
                      - linkedin
                      - threads
                      - reddit
                      - mastodon
                      - facebook
                      - substack
                      - whatsapp
                      - telegram
                      - bluesky
                      - snapchat
                      - medium
                      - quora
                      - nextdoor
                      - rumble
                      - xiaohongshu
                      - pinterest
                      - tumblr
                      - discord
                      - vimeo
                      - devto
                      - hashnode
                      - google_business
                      - lemmy
                      - yelp
                      - yellowpages
                      - bing_places
                      - apple_business
                automationMode:
                  default: review-first
                  type: string
                  enum:
                    - manual
                    - review-first
                    - fire-and-forget
                status:
                  default: draft
                  type: string
                  enum:
                    - draft
                    - scheduled
                    - active
                    - paused
                    - completed
                scheduledAt:
                  default: null
                  anyOf:
                    - type: string
                      format: date-time
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    - type: 'null'
                remixJobIds:
                  default: []
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                playbookId:
                  default: null
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 200
                    - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  campaign:
                    type: object
                    properties:
                      id:
                        type: string
                      title:
                        type: string
                      description:
                        type: string
                      connectedAccountIds:
                        type: array
                        items:
                          type: string
                      platforms:
                        type: array
                        items:
                          type: string
                          enum:
                            - tiktok
                            - instagram
                            - youtube
                            - x
                            - linkedin
                            - threads
                            - reddit
                            - mastodon
                            - facebook
                            - substack
                            - whatsapp
                            - telegram
                            - bluesky
                            - snapchat
                            - medium
                            - quora
                            - nextdoor
                            - rumble
                            - xiaohongshu
                            - pinterest
                            - tumblr
                            - discord
                            - vimeo
                            - devto
                            - hashnode
                            - google_business
                            - lemmy
                            - yelp
                            - yellowpages
                            - bing_places
                            - apple_business
                      automationMode:
                        type: string
                        enum:
                          - manual
                          - review-first
                          - fire-and-forget
                      status:
                        type: string
                        enum:
                          - draft
                          - scheduled
                          - active
                          - paused
                          - completed
                      scheduledAt:
                        anyOf:
                          - type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          - type: 'null'
                      remixJobIds:
                        type: array
                        items:
                          type: string
                      playbookId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      agentId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      assetCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      createdAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      updatedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    required:
                      - id
                      - title
                      - description
                      - connectedAccountIds
                      - platforms
                      - automationMode
                      - status
                      - scheduledAt
                      - remixJobIds
                      - playbookId
                      - createdAt
                      - updatedAt
                required:
                  - success
                  - campaign
                additionalProperties: {}
        '400':
          description: 'Failure. `code` is one of: invalid_request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Failure. `code` is one of: unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: 'Failure. `code` is one of: insufficient_credits, budget_capped.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Failure. `code` is one of: forbidden, origin_not_allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Failure. `code` is one of: not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'Failure. `code` is one of: conflict.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: 'Failure. `code` is one of: payload_too_large.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Failure. `code` is one of: rate_limited.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failure. `code` is one of: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: 'Failure. `code` is one of: upstream_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Failure. `code` is one of: capability_unavailable,
            upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: >-
            Human-readable. Copy may change between releases — do not match on
            it.
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - origin_not_allowed
            - not_found
            - conflict
            - payload_too_large
            - insufficient_credits
            - budget_capped
            - rate_limited
            - capability_unavailable
            - upstream_unavailable
            - upstream_error
            - internal_error
          description: Stable machine-readable cause. Branch on this.
        details:
          description: Optional structured context, e.g. the credits shortfall.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````