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

# Cancel

> Request cancellation of an exact run, retaining published work

CLI: `adside creatives cancel`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/creatives/{dropId}/runs/{runId}/cancel
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/creatives/{dropId}/runs/{runId}/cancel:
    post:
      tags:
        - Creatives
      summary: Cancel
      description: |-
        Request cancellation of an exact run, retaining published work

        CLI: `adside creatives cancel`
      operationId: creatives.cancel
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: dropId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: runId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  dropId:
                    type: string
                    minLength: 1
                    maxLength: 300
                  runId:
                    type: string
                    minLength: 1
                    maxLength: 300
                  requestId:
                    type: string
                    minLength: 1
                    maxLength: 200
                  status:
                    type: string
                    enum:
                      - QUEUED
                      - RUNNING
                      - NEEDS_CONFIRMATION
                      - DELIVERED
                      - PARTIAL
                      - FAILED
                      - CANCELLED
                  targets:
                    maxItems: 30
                    type: array
                    items:
                      type: object
                      properties:
                        creativeId:
                          type: string
                          minLength: 1
                          maxLength: 300
                        number:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                        baseCreativeRevisionId:
                          anyOf:
                            - type: string
                              minLength: 1
                              maxLength: 300
                            - type: 'null'
                      required:
                        - creativeId
                        - number
                        - baseCreativeRevisionId
                      additionalProperties: false
                  contextPath:
                    type: string
                  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))$
                  attempt:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  progress:
                    anyOf:
                      - type: object
                        properties:
                          phase:
                            type: string
                            minLength: 1
                            maxLength: 200
                          completed:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          total:
                            type: integer
                            minimum: 0
                            maximum: 30
                        required:
                          - phase
                          - completed
                          - total
                        additionalProperties: false
                      - type: 'null'
                  result:
                    anyOf:
                      - type: object
                        properties:
                          summary:
                            type: string
                          published:
                            maxItems: 30
                            type: array
                            items:
                              type: object
                              properties:
                                creativeId:
                                  type: string
                                  minLength: 1
                                  maxLength: 300
                                number:
                                  type: integer
                                  exclusiveMinimum: 0
                                  maximum: 9007199254740991
                                creativeRevisionId:
                                  type: string
                                  minLength: 1
                                  maxLength: 300
                                renders:
                                  type: object
                                  propertyNames:
                                    type: string
                                    enum:
                                      - story
                                      - portrait
                                      - square
                                      - landscape
                                      - wide
                                      - twitter
                                      - link
                                  additionalProperties:
                                    type: string
                                    minLength: 1
                                    maxLength: 300
                              required:
                                - creativeId
                                - number
                                - creativeRevisionId
                                - renders
                              additionalProperties: false
                          failures:
                            maxItems: 30
                            type: array
                            items:
                              type: object
                              properties:
                                creativeId:
                                  type: string
                                  minLength: 1
                                  maxLength: 300
                                reason:
                                  type: string
                                  minLength: 1
                              required:
                                - creativeId
                                - reason
                              additionalProperties: false
                        required:
                          - summary
                          - published
                          - failures
                        additionalProperties: false
                      - type: 'null'
                  cancellationRequested:
                    type: boolean
                  cleanupStatus:
                    type: string
                    enum:
                      - PENDING
                      - CLEAN
                      - FAILED
                required:
                  - dropId
                  - runId
                  - requestId
                  - status
                  - targets
                  - createdAt
                  - attempt
                  - progress
                  - result
                  - cancellationRequested
                  - cleanupStatus
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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