API Guide

Complete Campaign

This API allows you to manually complete a campaign that is listed as Processing. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: PUT

Endpoint URL:


Sample Output:

"status": "success"


Parameter Description Acceptable Values Required
id The unique identifier of the campaign. Integer Y
xheader Unique X-250ok-CID header sent with the campaign. String Y*
* Either 'xheader' or 'id' can be passed. Both are not required.

Status Responses

Status Description
success 'status' => 'success' indicates that the update was successful.
failed 'status' => 'failed' indicates that the update failed.

Error Responses

Description Code Cause
Invalid campaign ID. 404 The unique identifier of the campaign is invalid
No results found. 404 We couldn't find any results matching your criteria.