> ## 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.

# Edit

> Edit exact creative IDs, numbers or explicit all, using the active drop-chat turn when called from its resident

CLI: `adside creatives edit`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/creatives/{dropId}/runs
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:
    post:
      tags:
        - Creatives
      summary: Edit
      description: >-
        Edit exact creative IDs, numbers or explicit all, using the active
        drop-chat turn when called from its resident


        CLI: `adside creatives edit`
      operationId: creatives.edit
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: dropId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              anyOf:
                - type: object
                  properties:
                    requestId:
                      type: string
                      minLength: 1
                      maxLength: 200
                    instruction:
                      type: string
                      minLength: 1
                      maxLength: 10000
                    references:
                      default: []
                      maxItems: 20
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: asset
                              assetId:
                                type: string
                                minLength: 1
                                maxLength: 300
                            required:
                              - type
                              - assetId
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                                const: competitor-ad
                              adId:
                                type: string
                                minLength: 1
                                maxLength: 300
                                description: >-
                                  Canonical ad feed ID:
                                  source:trackedCompanyId:cachedAdId
                            required:
                              - type
                              - adId
                            additionalProperties: false
                    expectedCreativeRevisionIds:
                      type: object
                      propertyNames:
                        type: string
                        minLength: 1
                        maxLength: 300
                      additionalProperties:
                        anyOf:
                          - type: string
                            minLength: 1
                            maxLength: 300
                          - type: 'null'
                    formatAdaptation:
                      type: object
                      properties:
                        requiredFormats:
                          minItems: 1
                          maxItems: 7
                          type: array
                          items:
                            type: string
                            enum:
                              - story
                              - portrait
                              - square
                              - landscape
                              - wide
                              - twitter
                              - link
                      required:
                        - requiredFormats
                      additionalProperties: false
                    targetCreativeIds:
                      minItems: 1
                      maxItems: 30
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                  required:
                    - requestId
                    - instruction
                    - targetCreativeIds
                  additionalProperties: false
                - type: object
                  properties:
                    requestId:
                      type: string
                      minLength: 1
                      maxLength: 200
                    instruction:
                      type: string
                      minLength: 1
                      maxLength: 10000
                    references:
                      default: []
                      maxItems: 20
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: asset
                              assetId:
                                type: string
                                minLength: 1
                                maxLength: 300
                            required:
                              - type
                              - assetId
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                                const: competitor-ad
                              adId:
                                type: string
                                minLength: 1
                                maxLength: 300
                                description: >-
                                  Canonical ad feed ID:
                                  source:trackedCompanyId:cachedAdId
                            required:
                              - type
                              - adId
                            additionalProperties: false
                    expectedCreativeRevisionIds:
                      type: object
                      propertyNames:
                        type: string
                        minLength: 1
                        maxLength: 300
                      additionalProperties:
                        anyOf:
                          - type: string
                            minLength: 1
                            maxLength: 300
                          - type: 'null'
                    formatAdaptation:
                      type: object
                      properties:
                        requiredFormats:
                          minItems: 1
                          maxItems: 7
                          type: array
                          items:
                            type: string
                            enum:
                              - story
                              - portrait
                              - square
                              - landscape
                              - wide
                              - twitter
                              - link
                      required:
                        - requiredFormats
                      additionalProperties: false
                    targetCreativeNumbers:
                      minItems: 1
                      maxItems: 30
                      type: array
                      items:
                        type: integer
                        exclusiveMinimum: 0
                        maximum: 9007199254740991
                  required:
                    - requestId
                    - instruction
                    - targetCreativeNumbers
                  additionalProperties: false
                - type: object
                  properties:
                    requestId:
                      type: string
                      minLength: 1
                      maxLength: 200
                    instruction:
                      type: string
                      minLength: 1
                      maxLength: 10000
                    references:
                      default: []
                      maxItems: 20
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: asset
                              assetId:
                                type: string
                                minLength: 1
                                maxLength: 300
                            required:
                              - type
                              - assetId
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                                const: competitor-ad
                              adId:
                                type: string
                                minLength: 1
                                maxLength: 300
                                description: >-
                                  Canonical ad feed ID:
                                  source:trackedCompanyId:cachedAdId
                            required:
                              - type
                              - adId
                            additionalProperties: false
                    expectedCreativeRevisionIds:
                      type: object
                      propertyNames:
                        type: string
                        minLength: 1
                        maxLength: 300
                      additionalProperties:
                        anyOf:
                          - type: string
                            minLength: 1
                            maxLength: 300
                          - type: 'null'
                    formatAdaptation:
                      type: object
                      properties:
                        requiredFormats:
                          minItems: 1
                          maxItems: 7
                          type: array
                          items:
                            type: string
                            enum:
                              - story
                              - portrait
                              - square
                              - landscape
                              - wide
                              - twitter
                              - link
                      required:
                        - requiredFormats
                      additionalProperties: false
                    allCreatives:
                      type: boolean
                      const: true
                  required:
                    - requestId
                    - instruction
                    - allCreatives
                  additionalProperties: false
      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
                required:
                  - dropId
                  - runId
                  - requestId
                  - status
                  - targets
                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.