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": { /* params */
"SelectionCriteria": { /* IdsCriteria */
"Ids": [(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 long | IDs of campaigns to archive (maximum of 1000). | Yes |
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 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) | ||
---|---|---|
ArchiveResults | array of ActionResult | Results of archiving campaigns. |
ActionResult structure | ||
Id | long | The campaign ID. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |
Parameter | Type | Description |
Result structure (for JSON) / ArchiveResponse structure (for SOAP) | ||
---|---|---|
ArchiveResults | array of ActionResult | Results of archiving campaigns. |
ActionResult structure | ||
Id | long | The campaign ID. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |