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

# Companies refresh-ads

> Refresh tracked-company ads, with explicit force for an already populated library

CLI: `adside research companies refresh-ads`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/research/companies/{companyId}/ad-refresh
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}/research/companies/{companyId}/ad-refresh:
    post:
      tags:
        - Research
      summary: Companies refresh-ads
      description: >-
        Refresh tracked-company ads, with explicit force for an already
        populated library


        CLI: `adside research companies refresh-ads`
      operationId: research.companies.refresh-ads
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: companyId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                forceRefresh:
                  default: false
                  type: boolean
                confirmationToken:
                  type: string
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                oneOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        const: refreshing
                      availableAt:
                        type: string
                    required:
                      - status
                      - availableAt
                    additionalProperties: false
                  - type: object
                    properties:
                      status:
                        type: string
                        const: queued
                      companyId:
                        type: string
                      companyName:
                        type: string
                    required:
                      - status
                      - companyId
                      - companyName
                    additionalProperties: false
                  - type: object
                    properties:
                      status:
                        type: string
                        const: started
                      companyId:
                        type: string
                      companyName:
                        type: string
                      runs:
                        type: array
                        items:
                          type: object
                          properties:
                            source:
                              type: string
                              enum:
                                - META
                                - GOOGLE
                                - LINKEDIN
                            runId:
                              type: string
                            status:
                              type: string
                              enum:
                                - PENDING
                                - RUNNING
                            origin:
                              type: string
                              enum:
                                - started
                                - already_running
                          required:
                            - source
                            - runId
                            - status
                            - origin
                          additionalProperties: false
                      skipped:
                        type: array
                        items:
                          type: string
                          enum:
                            - META
                            - GOOGLE
                            - LINKEDIN
                    required:
                      - status
                      - companyId
                      - companyName
                      - runs
                      - skipped
                    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.