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 */
  }
}
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 long IDs 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 */
  }
}
Parameter Type Description
Result structure (for JSON) / SuspendResponse structure (for SOAP)
SuspendResults array of ActionResult Results of resuming displays for the audience targets.
ActionResult structure
Id long ID of the audience target. 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.