required path parameter
The ID of the campaign to update
New campaign title
New campaign description
New date/time when the campaign becomes available
New date/time when the campaign ceases to be available
New text to include in purchase receipts
1 or 0. If 1, access to the campaign requires users to have a delivery address in their SPiD profile
1 or 0. If 1, access to the campaign requires users to have a valid and available voucher
New maximum number of purchases allowed for this campaign
New list of products in this campaign
curl https://login.schibsted.com/api/2/campaign/23494 \ -X POST \ -H "Authorization: Bearer [access token]"
With all parameters
curl https://login.schibsted.com/api/2/campaign/23494 \ -X POST \ -H "Authorization: Bearer [access token]" \ -d "title=Freebies for all" \ -d "description=Some information" \ -d "metaData=Meta" \ -d "status=0" \ -d "startDate=2016-06-01" \ -d "stopDate=2014-07-01" \ -d "additionalReceiptInfo=Special deal" \ -d "requireAddress=1" \ -d "requireVoucher=1" \ -d "limit=10" \ -d "products="
Returns the updated campaign object
Campaigns are groups of products that may be given new prices when purchased through the campaign. For a campaign to be applied to a purchase, it’s
campaignId needs to be part of the purchase URL. Campaigns may have limitations on their availability in time (start and stop dates), count (ie how many times it has been used), voucher (requires a valid voucher code to use) or address (the user must supply a physical address in order to use it).
Although campaigns are intended for temporary special offers, they may also be used as permanent way of getting lists of products. For this use case one has to be aware that the
newPrice of campaign products does not update automatically if the product price is updated.
The campaign's unique ID. Needs to be part of any purchase URL that should have the campaign applied
ID of the client that owns this campaign
Additional campaign description
Not used by Schibsted account, for client-specific meta-data
When the campaign starts/becomes active
When the campaign stops/ceases to be active
Additional text to include in purchase receipts for this campaign
string, "1" (true) or "0" (false)
string, "1" (true) or "0" (false)
Maximum number of purchases allowed for this campaign
The number of purchases made on this campaign so far
When the campaign was last updated
When the campaign was created
list of Campaign products
The campaign's products
The check mark ✓ indicates that the field always contains a valid non-empty value.
An enum, with the following possible values:
Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.
- 401 Unauthorized You don't have administration rights for this client.
- 401 Unauthorized Your client doesn't have administration rights for this client.
- 403 Forbidden Client is not authorized to access this API endpoint. Contact Schibsted account to request access.
- 403 Forbidden Requesting IP is not whitelisted
- 403 Forbidden Access token rejected
- 404 Not Found Unknown client ID
- 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
- 404 Not Found Campaign not found
- 420 Request Ratelimit exceeded
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.