Delete Campaigns

Endpoint

DELETE /unified/ads/campaigns/{id}

Integrations supported

• Meta Marketing API

Path parameters

id

string

REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

Loading...

integrated_account_id

string · uuid

REQUIRED · 

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

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

truto_response_format

string

The format of the response.

• unified will return the response with unified mappings applied.
• raw will return the raw response from the remote API.
• normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:

• unified
• raw
• normalized

Example: unified

truto_ignore_remote_data

boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields

array

Array of fields to exclude from the response.

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

remote_query

object

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

Response Body

Loading...

id

string

REQUIRED · 

The unique identifier for the campaign.

name

string

The name of the campaign.

status

string

The status of the campaign.

All possible enum values:

• active
• inactive
• draft
• paused
• deleted
• archived
• in_process
• with_issues
• completed
• canceled
• pending_deletion

type

string

The type of the campaign

account_id

string

The unique identifier for the account.

labels

object[]

The labels for the campaign.

id

string

The unique identifier for the label.

name

string

The name of the label.

objective

string

The objective of the campaign.

All possible enum values:

• app_installs
• brand_awareness
• conversions
• visits
• job_applications
• event_responses
• lead_generation
• link_clicks
• local_awareness
• messages
• offer_claims
• outcome_app_promotion
• outcome_awareness
• outcome_engagement
• outcome_leads
• outcome_sales
• outcome_traffic
• page_likes
• post_engagement
• product_catalog_sales
• reach
• store_visits
• video_views

bid_strategy

object

The bid strategy for the campaign.

id

string

The unique identifier for the bid strategy.

name

string

The name of the bid strategy.

All possible enum values:

• lowest_cost_without_cap
• lowest_cost_with_bid_cap
• cost_cap

buying_type

string

The buying type for the campaign.

All possible enum values:

• auction
• reserved

budget

object

The budget for the campaign.

id

string

The unique identifier for the budget.

remaining

string

The remaining budget for the campaign.

lifetime_max

string

The max budget for the campaign.

daily_max

string

The daily max budget for the campaign.

is_scheduling_enabled

boolean

Whether budget scheduling is enabled for the campaign.

is_rebalance_enabled

boolean

Whether budget rebalancing is enabled for the campaign.

is_shared

boolean

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

spend

object

The spend for the campaign.

max_cap

string

The max cap spend for the campaign.

cap_enabled

boolean

Whether the cap is enabled for the campaign.

primary_attribution

string

The primary attribution for the campaign.

special_ad_categories

string[]

The special ad categories for the campaign.

All possible enum values:

• credit
• employment
• housing
• none
• political
• social_issues

special_ad_category

string

The special ad category for the campaign.

All possible enum values:

• credit
• employment
• housing
• none
• political
• social_issues

start_time

string · date-time

The start time for the campaign.

stop_time

string · date-time

The stop time for the campaign.

created_at

string · date-time

The date and time the campaign was created.

updated_at

string · date-time

The date and time the campaign was last updated.

remote_data

object

Raw data returned from the remote API call.