CreateSpendCap

post

https://<platform>-mgmt.mcm-api.moloco.com/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spend-caps

Create a spend cap of an ad account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

platform_id

string

required

Identifier of the platform who requests management api. It is passed as a path parameter.

ad_account_id

string

required

AdAccount id.

Body Params

title

string

Title of spend cap. Required.

schedule

object

Campaign's interval with start and end timestamps in RFC3339 format.
The Campaign will conceptually run during [schedule_start, schedule_end] inclusively.
It is highly recommended that schedule.start is set to UTC corresponding to the beginning of the day (00:00:00), and schedule.end is set to UTC corresponding to the end of the day (23:59:59) both in the ad account's timezone.
If you want to set no end date, make sure your platform supports no end date setting and just leave schedule_end blank.

budget

object

Budget is the SpendCap-specific budget shape. Intentionally
separate from common.Budget (used by campaigns) so the Period
enum can carry MONTHLY without leaking the value to campaign
surfaces.

comment

string

A reference comment for transaction. Optional.

purpose

string

enum

Defaults to UNKNOWN_PURPOSE

Purpose discriminates between SpendCaps representing the
advertiser's own funds (ADVERTISER_FUNDS, the default and
historical behavior) and platform-issued credits (CREDITS).
ADVERTISER_FUNDS on the public API maps to FUNDS on the
internal storage proto.

Allowed:

campaign_assignment_scope

string

enum

Defaults to UNKNOWN_CAMPAIGN_ASSIGNMENT_SCOPE

CampaignAssignmentScope selects whether this SpendCap applies
only to explicitly assigned campaigns or to every campaign in
the owning ad account. Mirrors the AlloyDB enum
{platform}.spend_cap_campaign_assignment_scope_enum.

Allowed:

Responses

200A successful response.

400Bad request. Detailed cause can be found in the response message.

401Unauthorized.

403Permission denied.

404Not found. One or more required resources do not exist.You can see the details in the response message.

500Internal server error. Detailed cause can be found in the response message.