Update an existing Campaign.

put

https://api.moloco.cloud/cm/v1/campaigns/{campaign_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaign_id

string

required

The ID of the Campaign to be updated.

Body Params

The Campaign to update.

string

Unique identifier of the Campaign. Automatically set by server on creation.

title

string

required

A descriptive name of the Campaign.

description

string

An optional description of the Campaign.

enabling_state

string

enum

Defaults to UNSPECIFIED

Enumeration of the enabling states with a default UNSPECIFIED state.

Allowed:

type

string

enum

required

Defaults to UNKNOWN_CAMPAIGN_TYPE

CampaignType represents the type of a Campaign. It captures the goal of the Campaign at a high level.

This value is not part of the specification.

GENERIC: Campaign is for generic purpose (only for legacy Campaigns).
APP_USER_ACQUISITION: The goal of the Campaign is to drive app user acquisitions.
APP_REENGAGEMENT: The goal of the Campaign is to drive app reengagement.
WEBSITE_VISIT: The goal of the Campaign is to drive website visits.
CTV_GENERIC: Campaign is for the general CTV ad.
CTV_APP_USER_ACQUISITION: Campaign is for the mobile app install CTV ad.
WEB_USER_ACQUISITION: The goal of the Campaign is to drive web user acquisitions. Originally, this was used for APP to WEB user acquisition. However, it is now also used for WEB to WEB user acquisition.
CTV_WEBSITE_VISIT: Campaign is for the website visit CTV ad.
WEB_RETARGETING: The goal of the Campaign is to drive web retargeting. Currently, this is used for WEB to WEB retargeting.

device_os

string

enum

required

Defaults to UNKNOWN_DEVICE_OS

Enumeration of device OS types supported by Moloco Ads.

This value is not part of the specification.

ANDROID: Android device OS.
IOS: iOS device OS.
VERSATILE: Product with multiple OSes. Specifically for CTV.
MOBILE_WEB: OS for mobile web traffic.
MACOS: OS for MacOS traffic.
WINDOWS: OS for Windows traffic.
NEXT_VERSATILE: OS for Next web product.

state

string

enum

Defaults to UNKNOWN_CAMPAIGN_STATE

CampaignState represents various states of a Campaign.

This value is not part of the specification.

SUBMITTED: All the required data are entered and passed all the validation. It's eligible to be reviewed by Moloco for activation.
READY: Campaign is before schedule and internally ready but disabled. Will transit to PAUSED when it becomes on schdule.
UPCOMING: Campaign is before schedule and internally ready and disabled. Will transit to ACTIVE when it becomes on schdule.
ACTIVE: Campaign is on schedule and spending the budget.
PAUSED: Campaign is paused and not spending the budget.
SUSPENDED: Campaign activation is suspended by the system for the following reasons:
App has been found to be in violation of Moloco's creative policy.
COMPLETED: Campaign is completed but may still get attributions for some time.

countries

array of strings

required

Countries in which this Campaign runs. The value format is ISO-3166-1 Alpha-3 using uppercase letters only, such as "KOR" or "USA". Note that the values for this field will be used to filter bid requests by country name.

countries*

currency

string

enum

Defaults to UNKNOWN_CURRENCY

Enumeration of currencies supported by Moloco Ads.

This value is not part of the specification.

USD: US Dollar.
KRW: Korean Won.
JPY: Japanese Yen.
EUR: EU Euro.
GBP: British Pound.

Allowed:

schedule

object

required

Interval with start and end timestamps in RFC3339 format.

budget_schedule

object

BudgetSchedule represents the AdAccount's plan for budget spending. Any change in this object takes effect immediately.

tracking_company

string

enum

Defaults to UNKNOWN_TRACKING_COMPANY

Enumeration for tracking companies supported by Moloco Ads.

WEB: Unnamed trackers
AIRBRIDGE: Moloco's e2e tracker (test purpose only)
KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking company.

tracking_link_id

string

MMP specific impression and click TrackingLinks defined specifically for this Campaign. Campaign can be either WEB type or APP type. Required for APP type campaign, not allowed for WEB type Campaign.

landing_url

string

The URL of the website that a Campaign wants to show to the audience. Required for web type Campaign.

goal

object

required

CampaignGoal describes the details of goal of a Campaign.

skadn_input

object

SKAdNetworkInput represents various configurations w.r.t SKAdNetwork traffic. It's meaningful only for IOS. Use case in MCP: https://help.moloco.com/hc/en-us/articles/1500005837321-SKAdNetwork-Campaign-Settings.

custom_key_values

object

Custom key/values managed by the Moloco Ads client platform. It's up to the client ads platform to define the schema for the values and their optionality.

The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix.

For complex values, JSON payload is recommended.

Moloco doesn't interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative's value having the highest precedence on the same key.

ad_tracking_allowance

string

enum

Defaults to UNKNOWN_AD_TRACKING_ALLOWANCE

AdTrackingAllowance represents targeting conditions regarding personalized ad tracking.

This value is not part of the specification.

NON_LAT_ONLY: Campaign will bid only to the traffic with IDFA as usual Campaigns.
LAT_ONLY: Campaign will bid only to the traffic without IDFA. Limited Ad Tracking only.
DO_NOT_CARE: Campaign will not care whether it has an IDFA or not. Default as of now.

Allowed:

updated_at

date-time

Last updated time. Should not modify on the client side.

serving_status

object

ServingStatus stores current serving status of the campaign, such as whether it is blocked and when it is blocked.

launch_notice_confirmations

array of objects

The list of launch notice that the user has explicitly reviewed and confirmed. The client must echo back the notices received in 'launch_notices' when enabling the campaign. The server validates these against the current system state to ensure all required acknowledgments are present.

Starting from v1.10.0, any campaign enable request that does not include all 'DISCLAIMER' type notices received in 'launch_notices' will be rejected.

launch_notice_confirmations

Responses

200A successful response.

defaultError. Detailed cause can be found in the details field.