PUT api/subscription/budgetlock/set

This endpoint allows you to set a lock on the budget preventing the user from seeing the "Adjust Budget" button in the UI. It does not prevent API changes to the budget.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Budget Lock (Modify)

Name	Description	Type	Additional information
campaignId	Id of campaign tied to this subscription	integer	Required
budgetLockExpiration	Date when the campaign budget lock should expire. If blank the budget lock will be released. Expected format is yyyy-MM-dd HH:mm:ssK.	string

Request Formats

application/json, text/json

Sample:

{
  "campaignId": 111,
  "budgetLockExpiration": "2025-07-30 02:49:26+00:00"
}

application/xml, text/xml

Sample:

<BudgetLock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.UpdateModels">
  <budgetLockExpiration>2025-07-30 02:49:26+00:00</budgetLockExpiration>
  <campaignId>111</campaignId>
</BudgetLock>

Response Information

Successful Response:

Resource Description

Campaign Subscription

Name	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

Sample:

{
  "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

Sample:

<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>