Documentation

archive

Archives campaigns.

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": { 
    "SelectionCriteria
[no-highlight[

Criteria for selecting campaigns to archive.

Required

Yes

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

IDs of campaigns to archive (maximum of 1000).

Required

Yes

]no-highlight]
": [(long), ... ] /* required */ } /* required */ } }
Parameter Type Description Required
params structure (for JSON) / ArchiveRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting campaigns to archive.Yes
IdsCriteria structure
Ids array of longIDs of campaigns to archive (maximum of 1000).Yes

Response

Response structure in JSON format:

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

Results of archiving campaigns.

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

The campaign ID. 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) / ArchiveResponse structure (for SOAP)
ArchiveResults array of ActionResultResults of archiving campaigns.
ActionResult structure
Id longThe campaign ID. 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.