archive
Archives campaigns.
Learn more
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 */
}
}
|
Parameter |
Type |
Description |
Required |
|
params structure (for JSON) / ArchiveRequest structure (for SOAP) |
|||
|
|
IdsCriteria |
Criteria for selecting campaigns to archive. |
Yes |
|
IdsCriteria structure |
|||
|
|
array of long |
IDs 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 */
}
}
|
Parameter |
Type |
Description |
|
result structure (for JSON) / ArchiveResponse structure (for SOAP) |
||
|
|
array of ActionResult |
Results of archiving campaigns. |
|
ActionResult structure |
||
|
|
long |
The campaign ID. Returned if there aren't any errors. See the section Operations on object arrays. |
|
|
array of ExceptionNotification |
Warnings that occurred during the operation. |
|
|
array of ExceptionNotification |
Errors that occurred during the operation. |