PUT api/subscription/resume/campaign/search
Reinstates a given search campaign's subscription. If reinstatement occurs before the set end of the campaign then the campaign is simply returned to active billing retaining all previous billing timelines. If the subscription is reinstated after the scheduled campaign end date then new charges apply immediately and the billing cycle is reset to the date of the reinstatement request.
Note: The ednpoint
api/subscription/reinstate/campaign/has been depricated and replced by
api/subscription/reinstate/campaign/search
Request Information
Authentication Method
Partner/Account AuthenticationURI Parameters
None.
Body Parameters
Search Campaign Subscription (Resume)Name | Description | Type | Additional information |
---|---|---|---|
campaignId |
Id of campaign for which the last subscription should be reinstated |
integer |
Required |
nextCharge |
Date when the campaign is expected to be charged next. For subscriptions with a type of Automatic this will be the date the spend is refilled and the partner is invoiced. For subscriptions with a type of Triggered this will represent the date when the spend is expected to be refilled. If not passed the date will remain its previous value. Expected format is yyyy-MM-dd HH:mm:ssK. |
string |
|
Request Formats
application/json, text/json
{ "campaignId": 111, "nextCharge": "2025-06-30 02:49:26+00:00" }
application/xml, text/xml
<SearchCampaignSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ResumeModels"> <campaignId>111</campaignId> <nextCharge>2025-06-30 02:49:26+00:00</nextCharge> </SearchCampaignSubscription>
Response Information
Successful Response:Resource Description
Campaign SubscriptionName | Description | Type | Additional information |
---|---|---|---|
id | integer |
|
|
name | string |
|
|
status | string |
|
|
type | string |
|
|
endDate | date |
|
|
subscription | Subscription Detail |
|
|
partnerSKUs | Collection of Partner Sku |
|
|
budgetLockExpiration | date |
|
|
subscriptionExpiration | date |
|
Response Formats
application/json, text/json
{ "id": 111, "name": "My campaign", "status": "Active", "type": "Search", "endDate": null, "subscription": { "budget": 1500.0, "currency": "USD", "active": true, "type": "SearchCampaign", "billingType": "Automatic", "nextCharge": "2025-07-30T02:49:26.5580935+00:00" }, "partnerSKUs": null, "budgetLockExpiration": null, "subscriptionExpiration": "2025-07-30T02:49:26.5580935+00:00" }
application/xml, text/xml
<CampaignSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels"> <budgetLockExpiration i:nil="true" /> <endDate i:nil="true" /> <id>111</id> <name>My campaign</name> <partnerSKUs i:nil="true" /> <status>Active</status> <subscription> <active>true</active> <billingType>Automatic</billingType> <budget>1500</budget> <currency>USD</currency> <nextCharge>2025-07-30T02:49:26.5580935+00:00</nextCharge> <type>SearchCampaign</type> </subscription> <subscriptionExpiration>2025-07-30T02:49:26.5580935+00:00</subscriptionExpiration> <type>Search</type> </CampaignSubscription>