Update Advertisers

Why Update Advertisers?

Occasionally, you may need to make changes to an existing campaign or flight. The Update Advertisers API endpoint enables you to update the settings for a given advertiser, allowing you to make edits and changes quickly and easily, without creating a new advertiser.

📘

Note

You can update all fields from Creative Advertisers except for id.

API Syntax

When using the Update Advertisers API endpoint, it is important to understand the syntax required to make the request. Because the Kevel API is a RESTful API, there is a specific request format that must be followed to ensure the endpoint can process the request. The format is:

PUT https://api.kevel.co/v1/advertiser/{AdvertiserID}

Where:

PUT - the type of API request being made.
https://api.kevel.co - the URL for the request.
v1 - the API version.
advertiser - the API endpoint being called.
AdvertiserID - The ID associated with the advertiser being updated.

❗️

Warning

Once you set IsDeleted on an advertiser object to true, you cannot set it to false again. Instead, the API will return: {"message":"This advertiser is deleted."}.

📘

Clearing attribute values

To unset or clear an attribute, set its value to NULL.

AdvertiserID

int32

required

ID of the Advertiser

Id

int32

required

The ID of the Advertiser

Title

string

required

The name of the advertiser

IsActive

boolean

required

Whether the advertiser is active

IsDeleted

boolean

If want to delete, set to true

`200 200

object

Id

integer

Defaults to 0

curl -X PUT -H 'X-Adzerk-ApiKey:<APIKEY>' -H "Content-Type:application/json" https://api.kevel.co/v1/advertiser/12345 --data-binary '{"Id":12345,"Title":"Nike","IsActive":true,"IsDeleted":false}'

Example Response

{
  "Id": 12345,
  "Title": "Nike",
  "IsActive": true,
  "IsDeleted": false,
  "PlacementLimit": 4,
  "FreqCap": 2,
  "FreqCapDuration": 10,
  "FreqCapType": 1,
  "CapType": 4,
  "DailyCapAmount": 5000,
  "LifetimeCapAmount": 50000
}