archive

Archives campaigns.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 1000 campaigns per method call.

You can't archive a campaign that has funds.

The campaign must be suspended before archiving.

Request

Request structure in JSON format:

{
  "method": "archive",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    } /* required */
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / ArchiveRequest structure (for SOAP)
SelectionCriteriaIdsCriteriaCriteria for selecting campaigns to archive.Yes
IdsCriteria structure
Idsarray of longIDs of campaigns to archive (maximum of 1000).Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "ArchiveResults": [{  /* 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) / ArchiveResponse structure (for SOAP)
ArchiveResultsarray of ActionResultResults of archiving campaigns.
ActionResult structure
IdlongThe campaign ID. 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.