Update Campaign

PATCH /campaigns/{id}

Copied

---

                https://api.ocamba.com/api/v1/adex/campaigns/{id}
            

Updates the specific Campaign by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters

---

Name

Description

idstringrequired

Unique identifier for the object defined as a path parameter.


Example: 12345

Request Body Schema

---

Name

Description

descriptionstring

Additional describtion of campaign, maximum 600 characters.


Example: Description goes here

---

frequency_capobject

Name

Description

impressionobject

Name

Description

expiry_timenumber

Time frame for frequency capping, expressed in hours.


Example: 10

---

max_countnumber

Max number of times a user sees ads for a given time frame.


Example: 2

---

iab_category[ string ]

An array of maximum 3 unique items, where every item must be a valid IAB category.


Example: IAB1-1,IAB1-2

---

namestringrequired

Name of the campaign, max 200 characters.


Example: DemoCampaign

---

scorenumber (integer)required

Minimum value - 0, Maximum value - 100.


Example: 78

Default: 50

---

statusstringrequired

The status reflects the current status of the campaign which may be overridden by its parent or by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit

Response status codes

---

204 - No Content

note

1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the campaign.