Reddit Ads

App · 23 actions

Manage Reddit ad accounts, campaigns, ad groups, ads and lead forms, and retrieve advertising reports.

Actions

ActionWhat it does
Create AdCreate an ad.
Create Ad GroupCreate an ad group.
Create CampaignCreate a campaign.
Create Lead Generation FormCreate a lead generation form in an ad account, to collect responses from people who interact with a lead generation ad that uses it.
Get A ReportGet a metrics report with the fields you choose, broken down by up to 3 breakdowns, or 4 when they include country and region.
Get AdGet an ad.
Get Ad AccountGet an ad account by its ID.
Get Ad GroupGet an ad group.
Get CampaignGet a campaign.
Get Lead Generation FormGet a lead generation form.
List Ad Accounts By BusinessList the ad accounts in a business.
List Ad GroupsList the ad groups in an ad account.
List AdsList the ads in an ad account.
List CampaignsList the campaigns in an ad account.
List Funding InstrumentsList the funding instruments an ad account uses.
List Lead Generation FormsList the lead generation forms in an ad account.
List My BusinessesList the businesses you have access to.
List Pixels By Ad AccountList the pixels linked to an ad account.
List Profiles By Ad AccountList the profiles linked to an ad account.
Update AdUpdate an ad.
Update Ad AccountUpdate an ad account.
Update Ad GroupUpdate an ad group.
Update CampaignUpdate a campaign.

Create Ad

Create an ad. For a Reddit Max campaign, create a dynamic creative ad template, as Reddit's Max campaign setup guide describes. For catalog sales ads, the click URL field explains how links are handled.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
DatadataobjectRequired
Ad create payload.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Create Ad Group

Create an ad group.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Create Campaign

Create a campaign. To create an automated Reddit Max campaign, follow Reddit's Max campaign setup guide.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}

Create Lead Generation Form

Create a lead generation form in an ad account, to collect responses from people who interact with a lead generation ad that uses it.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "created_at": "example",
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "privacy_link": "example",
      "prompt": "example",
      "questions": []
    }
  }
}

Get A Report

Get a metrics report with the fields you choose, broken down by up to 3 breakdowns, or 4 when they include country and region.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "metrics": [],
      "metrics_updated_at": "example"
    },
    "pagination": {
      "next_url": "example",
      "page_index": 1,
      "previous_url": "example",
      "total_count": 1
    }
  }
}

Get Ad

Get an ad.

Inputs

Ad idad_idtextRequired
Ad id.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Get Ad Account

Get an ad account by its ID.

Inputs

Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "admin_approval": "ADMIN",
      "app_attribution_type": "ALL_CONVERSION",
      "app_click_attribution_window": "DAY",
      "app_view_attribution_window": "DAY",
      "attribution_type": "ALL_CONVERSION",
      "business_id": "example",
      "click_attribution_window": "DAY",
      "created_at": "example",
      "currency": "AED",
      "excluded_communities": [],
      "excluded_keywords": [],
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "pixel_partner_preferences": [],
      "primary_contact_member_id": "example",
      "spend_cap_type": "LIFETIME",
      "suspension_reason": "ADVERTISING_POLICY",
      "time_zone_id": "Africa/Abidjan",
      "type": "MANAGED",
      "ugc_addon_default_on": false,
      "view_attribution_window": "DAY"
    }
  }
}

Get Ad Group

Get an ad group.

Inputs

Ad group idad_group_idtextRequired
Ad group id.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Get Campaign

Get a campaign.

Inputs

Campaign idcampaign_idtextRequired
Campaign id.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}

Get Lead Generation Form

Get a lead generation form.

Inputs

Lead gen form idlead_gen_form_idtextRequired
Lead gen form id.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "created_at": "example",
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "privacy_link": "example",
      "prompt": "example",
      "questions": []
    }
  }
}

List Ad Accounts By Business

List the ad accounts in a business.

Inputs

Businessbusiness_idtextRequired
Business id.
Idsidstext
Ids.
Page sizepage_sizenumber
Page size.At most 1000.
Page tokenpage_tokentext
Page token.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Ad Groups

List the ad groups in an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Campaign idcampaign_idtext
Campaign id.
Ididlist
Id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Ads

List the ads in an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Ididlist
Id.
Ad group idad_group_idlist
Ad group id.
Campaign idcampaign_idlist
Campaign id.
Configured statusconfigured_statuslist
Configured status.One or more of: ACTIVE, ARCHIVED, DELETED, PAUSED.
Effective statuseffective_statuslist
Effective status.One or more of: ACTIVE, AD_GROUP_PAUSED (Ad group paused), ARCHIVED, CAMPAIGN_PAUSED (Campaign paused), COMPLETED, DELETED, MISSING_PERMISSIONS (Missing permissions), PAUSED, PENDING_APPROVAL (Pending approval), PENDING_BILLING_INFO (Pending billing info), and 3 more.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Campaigns

List the campaigns in an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Ididlist
Id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Funding Instruments

List the funding instruments an ad account uses.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Funding instrument idsfunding_instrument_idslist
Funding instrument ids.
Typestypeslist
Types.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Searchsearchtext
Search.
Modemodetext
Mode.One of: ACTIVE, INACTIVE, UPCOMING, SELECTABLE, ALL.
Is selectableis_selectabletrue/false
Is selectable.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Lead Generation Forms

List the lead generation forms in an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List My Businesses

List the businesses you have access to. You can filter them by your level of access.

Inputs

Ad accountad_account_idtext
Ad account id.
Roleroletext
The user's role in a business. Used to filter businesses by the user's role.One of: BUSINESS_ADMIN (Business admin), CATALOG_ADMIN (Catalog admin).
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 700.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Pixels By Ad Account

List the pixels linked to an ad account.

Inputs

Ad accountad_account_idtextRequired
The ad account ID.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 1000.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

List Profiles By Ad Account

List the profiles linked to an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At most 100.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "next_url": "example",
      "previous_url": "example"
    }
  }
}

Update Ad

Update an ad. For catalog sales ads, the click URL field explains how links are handled.

Inputs

Ad idad_idtextRequired
Ad id.
DatadataobjectRequired
Partial ad update. The ad type is immutable. Existing clients may continue sending a matching `type`, but new integrations should omit it.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Update Ad Account

Update an ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "admin_approval": "ADMIN",
      "app_attribution_type": "ALL_CONVERSION",
      "app_click_attribution_window": "DAY",
      "app_view_attribution_window": "DAY",
      "attribution_type": "ALL_CONVERSION",
      "business_id": "example",
      "click_attribution_window": "DAY",
      "created_at": "example",
      "currency": "AED",
      "excluded_communities": [],
      "excluded_keywords": [],
      "id": "example",
      "modified_at": "example",
      "name": "example",
      "pixel_partner_preferences": [],
      "primary_contact_member_id": "example",
      "spend_cap_type": "LIFETIME",
      "suspension_reason": "ADVERTISING_POLICY",
      "time_zone_id": "Africa/Abidjan",
      "type": "MANAGED",
      "ugc_addon_default_on": false,
      "view_attribution_window": "DAY"
    }
  }
}

Update Ad Group

Update an ad group.

Inputs

Ad group idad_group_idtextRequired
Ad group id.
DatadataobjectRequired
Data.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {}
  }
}

Update Campaign

Update a campaign.

Inputs

Campaign idcampaign_idtextRequired
Campaign id.
Request bodyrequest_bodyobjectRequired
Request body.

Outputs

dataobject
Reddit Ads response data.
Example output
{
  "data": {
    "data": {
      "ad_account_id": "example",
      "app_id": "example",
      "bid_strategy": "BIDLESS",
      "bid_type": "CPC",
      "bid_value": 1,
      "configured_status": "ACTIVE",
      "conversion_pixel_id": "example",
      "created_at": "example",
      "delivery_status": [],
      "effective_status": "ACTIVE",
      "end_time": "example",
      "funding_instrument_id": "example",
      "goal_type": "LIFETIME_SPEND",
      "goal_value": 1,
      "id": "example",
      "invoice_label": "example",
      "is_campaign_budget_optimization": false,
      "is_max": false,
      "modified_at": "example",
      "name": "example",
      "objective": "APP_INSTALLS",
      "optimization_goal": "ADD_TO_CART",
      "schedule": [],
      "skadnetwork_metadata": {
        "status": "COOLDOWN"
      },
      "special_ad_categories": [],
      "spend_cap": 1,
      "start_time": "example",
      "type": "MANUAL",
      "use_catalog": false,
      "view_through_conversion_type": "SEVEN_DAY_CLICKS"
    }
  }
}

On this page