Update Campaigns

PATCH /unified/ads/campaigns/{id}

Meta Marketing API

Path Parameters

idstring

required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters

integrated_account_idstring · uuid

required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

truto_response_formatstring

The format of the response.

unified returns the response with unified mappings applied.
raw returns the unprocessed, raw response from the remote API.
normalized applies the unified mappings and returns the data in a normalized format.
stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified

Possible values:

unifiedrawnormalizedstreamdebug

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name

remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

bid_strategyobject

The bid strategy for the campaign.

idstring

The unique identifier for the bid strategy.

namestring

The name of the bid strategy.

Possible values:

lowest_cost_without_caplowest_cost_with_bid_capcost_cap

budgetobject

The budget for the campaign.

daily_maxstring

The daily max budget for the campaign.

idstring

The unique identifier for the budget.

is_rebalance_enabledboolean

Whether budget rebalancing is enabled for the campaign.

is_scheduling_enabledboolean

Whether budget scheduling is enabled for the campaign.

is_sharedboolean

Whether the budget is shared for the campaign with other campaigns.

lifetime_maxstring

The max budget for the campaign.

remainingstring

The remaining budget for the campaign.

labelsobject[]

The labels for the campaign.

idstring

The unique identifier for the label.

namestring

The name of the label.

namestring

The name of the campaign.

objectivestring

The objective of the campaign.

Possible values:

app_installsbrand_awarenessconversionsvisitsjob_applicationsevent_responseslead_generationlink_clickslocal_awarenessmessagesoffer_claimsoutcome_app_promotion+ 11 more

remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

special_ad_categoriesstring[]

The special ad categories for the campaign.

Possible values:

creditemploymenthousingnonepoliticalsocial_issues

special_ad_categorystring

The special ad category for the campaign.

Possible values:

creditemploymenthousingnonepoliticalsocial_issues

special_ad_category_country

1 supported

Meta Marketing API

supported

spendobject

The spend for the campaign.

cap_enabledboolean

Whether the cap is enabled for the campaign.

max_capstring

The max cap spend for the campaign.

start_timestring · date-time

The start time for the campaign.

stop_timestring · date-time

The stop time for the campaign.

Response Body

idstring

required·

The unique identifier for the campaign.

account_idstring

The unique identifier for the account.

bid_strategyobject

The bid strategy for the campaign.

idstring

The unique identifier for the bid strategy.

namestring

The name of the bid strategy.

Possible values:

lowest_cost_without_caplowest_cost_with_bid_capcost_cap

budgetobject

The budget for the campaign.

daily_maxstring

The daily max budget for the campaign.

idstring

The unique identifier for the budget.

is_rebalance_enabledboolean

Whether budget rebalancing is enabled for the campaign.

is_scheduling_enabledboolean

Whether budget scheduling is enabled for the campaign.

is_sharedboolean

Whether the budget is shared for the campaign with other campaigns.

lifetime_maxstring

The max budget for the campaign.

remainingstring

The remaining budget for the campaign.

buying_typestring

The buying type for the campaign.

Possible values:

auctionreserved

created_atstring · date-time

The date and time the campaign was created.

labelsobject[]

The labels for the campaign.

idstring

The unique identifier for the label.

namestring

The name of the label.

namestring

The name of the campaign.

objectivestring

The objective of the campaign.

Possible values:

app_installsbrand_awarenessconversionsvisitsjob_applicationsevent_responseslead_generationlink_clickslocal_awarenessmessagesoffer_claimsoutcome_app_promotion+ 11 more

primary_attributionstring

The primary attribution for the campaign.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

special_ad_categoriesstring[]

The special ad categories for the campaign.

Possible values:

creditemploymenthousingnonepoliticalsocial_issues

special_ad_categorystring

The special ad category for the campaign.

Possible values:

creditemploymenthousingnonepoliticalsocial_issues

spendobject

The spend for the campaign.

cap_enabledboolean

Whether the cap is enabled for the campaign.

max_capstring

The max cap spend for the campaign.

start_timestring · date-time

The start time for the campaign.

statusstring

The status of the campaign.

Possible values:

activeinactivedraftpauseddeletedarchivedin_processwith_issuescompletedcanceledpending_deletion

stop_timestring · date-time

The stop time for the campaign.

typestring

The type of the campaign

updated_atstring · date-time

The date and time the campaign was last updated.

truto unified ads campaigns '<resource_id>' \
  -m update \
  -a '<integrated_account_id>' \
  -b '{
  "labels": [],
  "bid_strategy": {},
  "budget": {},
  "name": "your_name",
  "objective": "app_installs",
  "special_ad_categories": [],
  "special_ad_category": "credit",
  "spend": {},
  "start_time": "your_start_time",
  "stop_time": "your_stop_time",
  "remote_data": {}
}' \
  -o json

import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.update(
  'ads',
  'campaigns',
  '<resource_id>',
  {
  "labels": [],
  "bid_strategy": {},
  "budget": {},
  "name": "your_name",
  "objective": "app_installs",
  "special_ad_categories": [],
  "special_ad_category": "credit",
  "spend": {},
  "start_time": "your_start_time",
  "stop_time": "your_stop_time",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);

import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.update(
        "ads",
        "campaigns",
        "<resource_id>",
        {
        "labels": [],
        "bid_strategy": {},
        "budget": {},
        "name": "your_name",
        "objective": "app_installs",
        "special_ad_categories": [],
        "special_ad_category": "credit",
        "spend": {},
        "start_time": "your_start_time",
        "stop_time": "your_stop_time",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X PATCH 'https://api.truto.one/unified/ads/campaigns/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "labels": [],
  "bid_strategy": {},
  "budget": {},
  "name": "your_name",
  "objective": "app_installs",
  "special_ad_categories": [],
  "special_ad_category": "credit",
  "spend": {},
  "start_time": "your_start_time",
  "stop_time": "your_stop_time",
  "remote_data": {}
}'

const integratedAccountId = '<integrated_account_id>';

const body = {
  "labels": [],
  "bid_strategy": {},
  "budget": {},
  "name": "your_name",
  "objective": "app_installs",
  "special_ad_categories": [],
  "special_ad_category": "credit",
  "spend": {},
  "start_time": "your_start_time",
  "stop_time": "your_stop_time",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/ads/campaigns/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/unified/ads/campaigns/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "labels": [],
    "bid_strategy": {},
    "budget": {},
    "name": "your_name",
    "objective": "app_installs",
    "special_ad_categories": [],
    "special_ad_category": "credit",
    "spend": {},
    "start_time": "your_start_time",
    "stop_time": "your_stop_time",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())