suspend

Stops ad displays.

Learn more

Restrictions

A maximum of 10,000 ads per method call.

You can't pause archived ads, drafts of ads (see Ad status and state), or ads that belong to an archived campaign.

Request

Request structure in JSON format:

{
  "method": "suspend",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    } /* required */
  }
}

Parameter	Type	Description	Required
params structure (for JSON) / SuspendRequest structure (for SOAP)
`SelectionCriteria`	IdsCriteria	Criteria for selecting ads to suspend.	Yes
IdsCriteria structure
`Ids`	array of long	IDs of the ads that you want to stop (no more than `ids-select`).	Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "SuspendResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ]
    }, ... ] /* required */
  }
}

Parameter	Type	Description
result structure (for JSON) / SuspendResponse structure (for SOAP)
`SuspendResults`	array of ActionResult	Results of suspending ads.
ActionResult structure
`Id`	long	The ad ID. Returned if there aren't any errors. See the section Operations on object arrays.
`Warnings`	array of ExceptionNotification	Warnings that occurred during the operation.
`Errors`	array of ExceptionNotification	Errors that occurred during the operation.

Was the article helpful?

resume

unarchive