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

# /2027-01/marketing-solutions/advertisers/{advertiser-id}/ads/pause

> Reports partial success: the ads that can be paused are paused even when others in the same
request are rejected. The response describes every requested ad id, in the order it was sent.



## OpenAPI

````yaml https://api.criteo.com/2027-01/marketingsolutions/open-api-specifications.json post /2027-01/marketing-solutions/advertisers/{advertiser-id}/ads/pause
openapi: 3.0.1
info:
  title: Criteo API
  description: Criteo API - MarketingSolutions
  version: 2027-01
servers:
  - url: https://api.criteo.com
security:
  - oauth: []
tags:
  - name: Advertiser
  - name: Analytics
  - name: Audience
  - name: Campaign
  - name: Creative
  - name: Gateway
  - name: Reco
paths:
  /2027-01/marketing-solutions/advertisers/{advertiser-id}/ads/pause:
    post:
      tags:
        - Creative
      summary: /2027-01/marketing-solutions/advertisers/{advertiser-id}/ads/pause
      description: "Reports partial success: the ads that can be paused are paused even when others in the same\r\nrequest are rejected. The response describes every requested ad id, in the order it was sent."
      operationId: PauseAdvertiserAds
      parameters:
        - name: advertiser-id
          in: path
          description: The advertiser identifier.
          required: true
          schema:
            type: string
      requestBody:
        description: "The ads to pause, carried as adIds. For example\r\n{\"data\":{\"type\":\"PauseAdsRequest\",\"attributes\":{\"adIds\":[\"12345\",\"12346\"]}}}."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfPauseAdsRequest'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: The outcome for each requested Ad is returned.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ValueResourceCollectionOutcomeOfAdDeliveryStatusUpdate
      security:
        - oauth:
            - MarketingSolutions_Creative_Manage
components:
  schemas:
    ValueResourceInputOfPauseAdsRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfPauseAdsRequest'
      description: >-
        A top-level object that encapsulates a Criteo API request for a single
        value.
    ValueResourceCollectionOutcomeOfAdDeliveryStatusUpdate:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ValueResourceOfAdDeliveryStatusUpdate'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: >-
        A top-level object that encapsulates a Criteo API response for several
        values.
    ValueResourceOfPauseAdsRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PauseAdsRequest'
        type:
          type: string
          nullable: true
      description: >-
        A top-level object that encapsulates a Criteo API response for a single
        value.
    ValueResourceOfAdDeliveryStatusUpdate:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdDeliveryStatusUpdate'
        type:
          type: string
          nullable: true
      description: >-
        A top-level object that encapsulates a Criteo API response for a single
        value.
    CommonProblem:
      type: object
      properties:
        code:
          type: string
          description: A machine-readable error code, expressed as a string value.
          nullable: true
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem
          nullable: true
        instance:
          type: string
          description: A URI that identifies the specific occurrence of the problem.
          nullable: true
        source:
          type: object
          additionalProperties:
            type: string
          description: >-
            A machine-readable structure to reference to the exact location(s)
            causing the error(s)
          nullable: true
        stackTrace:
          type: string
          nullable: true
        title:
          type: string
          description: A short human-readable description of the problem type
          nullable: true
        traceId:
          type: string
          description: The request correlation ID this problem comes from.
          nullable: true
        traceIdentifier:
          type: string
          description: >-
            The request correlation ID this problem comes from. (deprecated, use
            traceId instead)
          nullable: true
        type:
          enum:
            - unknown
            - access-control
            - authentication
            - authorization
            - availability
            - deprecation
            - quota
            - validation
          type: string
          description: The problem's category.
          nullable: true
      description: Common problem object.
    PauseAdsRequest:
      required:
        - adIds
      type: object
      properties:
        adIds:
          minItems: 1
          type: array
          items:
            type: string
      description: "The body of a pause request. It carries the ads to act on under the type name the contract gives this\r\noperation, \"PauseAdsRequest\": the status to apply comes from the operation that was called, so naming\r\nthe body is what tells the two operations apart. The SDK derives the type it announces from this class,\r\nso a caller that copies the contract is never refused."
    AdDeliveryStatusUpdate:
      required:
        - adId
        - result
      type: object
      properties:
        adDeliveryStatus:
          enum:
            - Live
            - Paused
          type: string
          description: "The ad's delivery status at the end of the operation. Omitted when the ad's existence cannot be\r\ndisclosed to this advertiser."
          nullable: true
        adId:
          type: string
          description: The ad this update describes.
        reason:
          type: string
          description: "Why the ad was rejected, set only when the result is \"Failed\",\r\n\"forbidden\", \"ad-archived\" and \"ad-creative-not-available-via-api\". Ads that do not belong to the advertiser,\r\nand entries that are not a usable ad id at all, are reported as \"forbidden\", exactly like ids\r\nthat do not exist."
          nullable: true
        result:
          enum:
            - Succeeded
            - Unchanged
            - Failed
          type: string
          description: >-
            Whether the ad reached the requested status, was already in it, or
            was rejected.
      description: "The outcome for one requested ad. The status update applied to one ad by a pause or unpause operation. A value type: the update is not\r\nan addressable resource, so it carries no id of its own and names its ad through adId."
      nullable: true
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.criteo.com/oauth2/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://api.criteo.com/oauth2
          tokenUrl: https://api.criteo.com/oauth2/token
          scopes: {}

````