suspend

Pauses displays for audience targets.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 10,000 audience targets per method call.

Request

Request structure in JSON format:

{
  "method": "suspend",
  "params": {  /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    } /* required */
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / SuspendRequest structure (for SOAP)
SelectionCriteriaIdsCriteriaCriteria for selecting audience targets to pause.Yes
IdsCriteria structure
Idsarray of longIDs of audience targets to suspend (maximum of 10,000).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 */
  }
}
ParameterTypeDescription
Result structure (for JSON) / SuspendResponse structure (for SOAP)
SuspendResultsarray of ActionResultResults of resuming displays for the audience targets.
ActionResult structure
IdlongID of the audience target. Returned if there aren't any errors. See the section Operations on object arrays.
Warningsarray of ExceptionNotification

Warnings that occurred during the operation.

Errorsarray of ExceptionNotification

Errors that occurred during the operation.