Documentation

suspend

Pauses displays for audience targets.

Restrictions

Maximum of 10,000 audience targets per method call.

Request

Request structure in JSON format:

{
  "method": "suspend",
  "params": {  
    "SelectionCriteria
[no-highlight[

Criteria for selecting audience targets to pause.

Required

Yes

]no-highlight]
": { /* IdsCriteria */ "Ids
[no-highlight[

IDs of audience targets to suspend (maximum of 10,000).

Required

Yes

]no-highlight]
": [(long), ... ] /* required */ } /* required */ } }
Parameter Type Description Required
params structure (for JSON) / SuspendRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting audience targets to pause.Yes
IdsCriteria structure
Ids array of longIDs of audience targets to suspend (maximum of 10,000).Yes

Response

Response structure in JSON format:

{
  "result": { 
    "SuspendResults
[no-highlight[

Results of resuming displays for the audience targets.

]no-highlight]
": [{ /* ActionResult */ "Id
[no-highlight[

ID of the audience target. Returned if there are no errors; see the section Operations on object arrays.

]no-highlight]
": (long), "Warnings
[no-highlight[

Warnings that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ], "Errors
[no-highlight[

Errors that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ] }, ... ] /* required */ } }
Parameter Type Description
result structure (for JSON) / SuspendResponse structure (for SOAP)
SuspendResults array of ActionResultResults of resuming displays for the audience targets.
ActionResult structure
Id longID of the audience target. Returned if there are no 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.