{"info":{"_postman_id":"a1a2883b-a6bf-4c29-ab5c-458f36417052","name":"NAM External API Documentation","description":"

Overview

\n

This Nextdoor Ads API is used to create and run campaigns on Nextdoor through the Nexdoor Ads Manager (NAM), which can be found at https://ads.nextdoor.com/v2. The API endpoints can be found at https://ads.nextdoor.com/v2/api

\n

While the API is meant to be exhaustive enough to do core operations such as creating/updating campaigns, adgroups, ads, and reporting, there are a few key operations that must be done via the UI. This includes:

\n\n

Availability

\n

The Nextdoor Ads API is currently in a closed BETA. If you are interested, please contact your Nextdoor Account Manager, or contact us for more information at ads-api@nextdoor.com.

\n

Authorization

\n

The NAM API uses Bearer Authentication to authorize requests. As such, you must provide the following HTTP header on all requests, with your API token:

\n
--header &#x27;Authorization: Bearer <token>&#x27;\n\n
\n

To obtain the API access token for a logged in user and a given account, please login to Nextdoor Ads Manager and head to the settings page https://ads.nextdoor.com/v2/manage/api to obtain an API token. A user may only have one API token at a given time; the token can also be revoked in the UI from the same settings page. API tokens expire after one year.

\n

The API token gives API callers the ability to take action on behalf of all advertisers that are tied to the NAM account. It also gives the ability to add new advertisers, of which the API based user will automatically be an admin for.

\n

End-to-end Examples

\n

In the following example, you'll go through the complete proces of verifying the correectness of an API token, creating an advertiser profile, and finally setting up a basic Campaign with a single Ad Gruop and Ad. For the full API reference, please see the sections below.

\n

Basic Usage

\n

Once you have your API token, you can test it out quickly by using the /me endpoint, which returns basic information about the currently authenticated user:

\n
curl 'https://ads.nextdoor.com/v2/api/me' --header 'Authorization: Bearer token123'\n\n
\n

Example response:

\n
{\n    \"user\": {\n      \"id\": \"01234\",\n      \"name\": \"Me\",\n      \"email\": \"me@example.com\",\n      \"email_confirmed\": true,\n      \"advertisers_with_access\": [\n        {\n          \"advertiser_id\": \"404\",\n          \"role\": \"CLIENT_ADMIN\"\n        }\n      ]\n    },\n    \"profile\": {\n      \"id\": \"32532\",\n      \"name\": \"my profile\",\n      \"associated_user_ids\": [\"01234\"],\n      \"payment_profile_id\": null,\n      \"is_ad_agency\": false\n    }\n}\n\n
\n

Create and Get an Advertiser

\n

Once you've verified your API token works, you can create an advertiser, and verify that the new advertiser can be queried for via its id.

\n

To create an advertiser, use the /advertiser/create endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/advertiser/create' \\\n--header 'Authorization: Bearer token123' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"my advertiser\",\n    \"website_url\": \"https://example.com\",\n    \"category_id\": \"121\"\n}'\n\n
\n

Example response:

\n
{\n    \"id\": \"12\",\n    \"name\": \"my advertiser\",\n    \"website_url\": \"https://example.com\",\n    \"category_id\": \"121\",\n    \"address\": null,\n    \"billing_limit\": \"USD 10\",\n    \"payment_profile_id\": null,\n    \"bill_to_paymnet_profile_id\": null,\n    \"account_balance\": \"USD 0\"\n}\n\n
\n

You can also directly query for an advertiser via the /advertiser/get/[id] endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/advetiser/get/12' --header 'Authorization: Bearer mytoken123'\n\n
\n

Example response:

\n
{\n    \"id\": \"12\",\n    \"name\": \"my advertiser\",\n    \"website_url\": \"example.com\",\n    \"category_id\": \"121\",\n    \"address\": null,\n    \"billing_limit\": \"USD 10\",\n    \"payment_profile_id\": null,\n    \"bill_to_paymnet_profile_id\": null,\n    \"account_balance\": \"USD 0\"\n}\n\n
\n

Create and Get a Campaign

\n

Now that there's an advertiser, you can create a new campaign using the /campaign/create endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/campaign/create' \\\n--header 'Authorization: Bearer token123' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"advertiser_id\": \"12\",\n    \"name\": \"my campaign\",\n    \"objective\": \"AWARENESS\"\n}'\n\n
\n

Example response:

\n
{\n    \"id\": \"123\",\n    \"name\": \"my campaign\",\n    \"objective\": \"AWARENESS\"\n}\n\n
\n

Similar to advertisers, you can directly query campaigns via the /campaign/get/[id] endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/campaign/get/123' --header 'Authorization: Bearer mytoken123'\n\n
\n

Example response:

\n
{\n    \"id\": \"123\",\n    \"name\": \"my campaign\",\n    \"objective\": \"AWARENESS\"\n}\n\n
\n

Get Targeting Options

\n

In order to create a new AdGroup for your campaign, you may want to find out what targeting options are supported. For example, to list the different device targeting options, use the /targeting/device/list endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/targeting/device/list' --header 'Authorization: Bearer'\n\n
\n

Example response:

\n
{\n    [\n        {\n            \"id\": \"1\",\n            \"value\": \"Android\"\n        },\n        {\n            \"id\": \"2\",\n            \"value\": \"iOS\"\n        }                \n    ]\n}\n\n
\n

Create an AdGroup

\n

Now that you have the targeting values, you can use those to create your own AdGroup for your campaign created earlier. For example let's say you want to create an AdGroup that targets \"Android\" users and users who are \"Pet Owners\" only, with a budget of $1,000 and a bid of $10 across all placements options. To do this, use the adgroup/create endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/adgroup/create' \\\n--header &#x27;Authorization: Bearer <token>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"advertiser_id\": \"12\",\n    \"campaign_id\": \"123\",\n    \"name\": \"my api adgroup\",\n    \"placements\": [\"FEED\", \"FSF\", \"RHR\"],\n    \"bid\": {\n        \"amount\": \"USD 10\",\n        \"pricing_type\": \"CPM\"\n    },\n    \"budget\": {\n        \"amount\": \"USD 1000\",\n        \"budget_type\": \"DAILY_CAP_MONEY\"\n    },\n    \"start_time\": \"2023-08-03T10:15:30-07:00[America/Los_Angeles]\",\n    \"end_time\": null,\n    \"targeting\": {\n        \"audience_targeting_features\": [\"1\"], // Android\n        \"interests_targeting\": {\n            \"include\": [[\"2\"]], // Pet owners\n            \"exclude\": []\n        }\n    },  \n}'\n\n
\n

Example response:

\n
{\n    \"id\": \"231\",\n    \"advertiser_id\": \"12\",\n    \"campaign_id\": \"123\",\n    \"name\": \"my api adgroup\",\n    \"status\": \"NO_ACTIVE_ADS\",\n    \"user_status\": \"ACTIVE\",\n    \"placements\": [\"FEED\", \"FSF\", \"RHR\"],\n    \"bid\": {\n        \"amount\": \"USD 10\",\n        \"pricing_type\": \"CPM\"\n    },\n    \"budget\": {\n        \"amount\": \"USD 1000\",\n        \"budget_type\": \"DAILY_CAP_MONEY\"\n    },\n    \"start_time\": \"2023-08-03T10:15:30-07:00[America/Los_Angeles]\",\n    \"end_time\": null,\n    \"frequency_caps\": [],\n    \"targeting\": {\n        \"included_location_targeting_features\": [],\n        \"excluded_location_targeting_features\": [],\n        \"audience_targeting_features\": [\"1\"],\n        \"interests_targeting\": {\n            \"include\": [[\"2\"]],\n            \"exclude\": []\n        },\n        \"custom_audience_targeting\": {\n            \"include\": [],\n            \"exclude\": []\n        },\n        \"time_of_day\": {\n            \"included\": [],\n            \"excluded\": []\n        }\n    },  \n    \"custom_audience_ids\": [],\n    \"created_at\": \"2023-08-03T17:15:30Z\",\n    \"updated_at\": \"2023-08-03T17:15:30Z\"\n}\n\n
\n

Creating an Ad

\n

At this point you have an Advertiser with its own Campaign; the Campaign also has its AdGroup. However, there is no ad traffic being served yet since you need to associate active Ad(s) to the newly created AdGroup above.

\n

Say you already have a Creative that's been used successfully running for a different Campaign/AdGroup. We can use that Creative's id when hitting the ad/create endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/ad/create' \\\n--header &#x27;Authorization: Bearer <token>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"my api ad\",\n    \"advertiser_id\": \"12\",\n    \"adgroup_id\": \"231\",\n    \"creative_id\": \"989\"\n}'\n\n
\n

Example response:

\n
{\n    \"id\": \"787\",\n    \"advertiser_id\": \"12\",\n    \"adgroup_id\": \"231\",\n    \"creative_id\": \"989\",\n    \"name\": \"my api ad\",\n    \"status\": \"ACTIVE\",\n    \"user_status\": \"ACTIVE\",\n    \"created_at\": \"2023-08-03T17:23:30Z\",\n    \"updated_at\": \"2023-08-03T17:23:30Z\"\n}\n\n
\n

Creating a Scheduled Report

\n

So now that you have a campaign that is serving a live Ad to user on Nextdoor, you will want to get metrics for how the Campaign, AdGroup, and Ad are performing over time. For example, to get a weekly report emailed to you that has a breakdown of impression metrics at the campaign level, you can use the reporting/scheduled/create endpoint:

\n
curl 'https://ads.nextdoor.com/v2/api/reporting/scheduled/create' \\\n--header &#x27;Authorization: Bearer <token>&#x27; \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"advertiser_id\": \"12\",\n    \"name\": \"my api scheduled report\",\n    \"schedule\": \"WEEKLY\",\n    \"recipient_emails\": [\"you@example.com\"],\n    \"dimension_granularity\": [\"CAMPAIGN\"],\n    \"time_granularity\": [\"DAY\"],\n    \"metrics\": [\"IMPRESSIONS\"],\n    \"campaign_ids\": [\"123\"],\n    \"adgroup_ids\": [],\n    \"ad_ids\": []\n}'\n\n
\n

Example response:

\n
{\n    \"id\": \"31\",\n    \"advertiser_id\": \"12\",\n    \"name\": \"my api scheduled report\",\n    \"schedule\": \"WEEKLY\",\n    \"timezone\": \"America/Los_Angeles\",\n    \"recipient_emails\": [\"you@example.com\"],\n    \"dimension_granularity\": [\"CAMPAIGN\"],\n    \"time_granularity\": [\"DAY\"],\n    \"metrics\": [\"IMPRESSIONS\"],\n    \"campaign_ids\": [\"123\"],\n    \"adgroup_ids\": [],\n    \"ad_ids\": [],\n    \"is_archived\": false\n}\n\n
\n

Endpoint Naming Schema

\n

API endpoints adhere to the general format below:

\n
<url>/<api_version>/<entity>/<verb>\n\n

As an example, the API endpoint to create a campaign is the following:

\n
https://ads.nextdoor.com/v2/api/campaign/create\n\n
\n

Some endpoints require a resource id (e.g. campaigns, ad groups, etc.). In those cases, the resource id is the last path element of the URL:

\n
https://ads.nextdoor.com/v2/api/campaign/get/123456789\n\n
\n

Verbs

\n

The following standard verbs are used across the entire API:

\n\n

Note that the API endpoint naming schema is explicit in the sense that the verbs are present directly in the URL path (independent of the specific HTTP method used for each endpoint). For more details on this, see the full API specification below.

\n

Data Types

\n

The NAM API data types include standard primitives, basic types, and resources. The NAM API is strict about nullability requirements - some API inputs and outputs are nullable, while others are required. In the complete reference, types are assumed to be non-nullable by default. If they are nullable, the type definition includes | null .

\n

The following are the primitive types supported in the API:

\n\n

The following are basic scalar types specific to the NAM API:

\n\n

In addition to primitive and custom scalar types, the NAM API also has a few custom types to support pagination:

\n\n

Finally, the NAM API exposes the following resources:

\n\n

Pagination

\n

The NAM API uses cursor based pagination. Some endpoints using the List verb include pagination parameters in the request input and return paginated data in the output.

\n\n

Rate Limiting

\n

Access to the NAM API is subject to rate limiting. The current rate limit is 100 requests/minute per advertiser.

\n

If you violate the rate limit, the API returns an HTTP 429 Too Many Requests error code. In this case, we recommend a few options:

\n\n

Resource Limits

\n

Nextdoor Ad Manager has limits in place for how many resources can exist at a given time for a given Advertiser; these limits apply only to entiities that do not have a status of \"Archived\":

\n\n

Error Handling

\n

The NAM API returns a set of standard of HTTP error codes for all endpoints, which includes:

\n\n

Versioning

\n

The NAM API is versioned. The current version of the API is v2.

\n

The documentation for the legacy v1 API can be found here; note that v1 and v2 are not compatible with each other, and we do not recommend using the v1 API, as it's subject to deprecation in the future.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Availability","slug":"availability"},{"content":"Authorization","slug":"authorization"},{"content":"End-to-end Examples","slug":"end-to-end-examples"},{"content":"Endpoint Naming Schema","slug":"endpoint-naming-schema"},{"content":"Verbs","slug":"verbs"},{"content":"Data Types","slug":"data-types"},{"content":"Pagination","slug":"pagination"},{"content":"Rate Limiting","slug":"rate-limiting"},{"content":"Resource Limits","slug":"resource-limits"},{"content":"Error Handling","slug":"error-handling"},{"content":"Versioning","slug":"versioning"}],"owner":"27150393","collectionId":"a1a2883b-a6bf-4c29-ab5c-458f36417052","publishedId":"2s93z6d3yj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-23T21:22:14.000Z"},"item":[{"name":"User","item":[{"name":"me","id":"e0325112-d648-4322-a727-fd6f299ab941","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

This endpoint returns information on the authenticated user accessing the API based on the passed in bearer token.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"7d66e760-8b62-4553-a598-3566ee4b8cfb","name":"me","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"email_confirmed\": \"\",\n \"advertisers_with_access\": [\n {\n \"advertiser_id\": \"adsId\",\n \"role\": \"\"\n }\n ]\n\n },\n \"profile\": {\n \"id\": \"\",\n \"name\": \"\",\n \"associated_user_ids\": [\"\"],\n \"payment_profile_id\": \"\",\n \"is_ad_agency\": \"\"\n }\n}"}],"_postman_id":"e0325112-d648-4322-a727-fd6f299ab941"}],"id":"b9eee99f-955a-4104-9dec-5bdfa2830fd9","_postman_id":"b9eee99f-955a-4104-9dec-5bdfa2830fd9","description":""},{"name":"Advertiser","item":[{"name":"advertiser/create","id":"0ce57491-6a4d-4765-b7ed-ac116bdf48bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"website_url\": \"\",\n \"category_id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Creates an advertiser that is tied to the NAM profile the API credentials are tied to. The \"name\" is a required input while \"wbesite_url\", \"category_id\", and \"address\" are all optional inputs.

\n

If \"address\" is passed in, then all inputs are required except for the \"street_address_2\" field which is optional; this represents additional information like an apartment or suite number.

\n

Upon a successful creation this will return the advertiser object.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"7e238285-d72f-444d-8985-7bd80dfb9acb","name":"advertiser/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"website_url\": \"\",\n \"category_id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"profile_id\": \"\",\n \"name\": \"\",\n \"website_url\": \"\",\n \"categories\": [\"\"],\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"billing_limit\": \"\",\n \"payment_profile_id\": \"\",\n \"bill_to_payment_profile_id\": \"\",\n \"account_balance\": \"\"\n}"}],"_postman_id":"0ce57491-6a4d-4765-b7ed-ac116bdf48bb"},{"name":"advertiser/update","id":"cb93510f-ea1b-4fb8-a99d-a556feb9d8ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"website_url\": \"\",\n \"user_set_billing_limit\": \"\",\n \"category_id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"bill_to_payment_profile_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates a NAM advertiser based on the inputs passed in. Aside from advertiser_id, all inputs are nullable and if passed in will be reflected in the returned advertiser object.

\n

The \"user_set_billing_limit\" field should be passed in the standardized Money format in order to be parsed correctly, please reference the \"Data Types\" section for more details.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"5500eb09-50a7-4c2d-a7a9-e8c107da25a6","name":"advertiser/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"website_url\": \"\",\n \"user_set_billing_limit\": \"\",\n \"category_id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"bill_to_payment_profile_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"profile_id\": \"\",\n \"name\": \"\",\n \"website_url\": \"\",\n \"categories\": [\"\"],\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"billing_limit\": \"\",\n \"payment_profile_id\": \"\",\n \"bill_to_payment_profile_id\": \"\",\n \"account_balance\": \"\"\n}"}],"_postman_id":"cb93510f-ea1b-4fb8-a99d-a556feb9d8ae"},{"name":"advertiser/get/","id":"ac0b0513-2c7c-442b-a606-004acd9f70f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns the advertiser object based on the id passed into the url's resource id.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"2bc47330-cccc-41cb-9c55-559752e59b99","name":"advertiser/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/advertiser/get/{id}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"profile_id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"website_url\": \"\",\n \"categories\": [\"\"],\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n \"billing_limit\": \"\",\n \"payment_profile_id\": \"\",\n \"bill_to_payment_profile_id\": \"\",\n \"account_balance\": \"\"\n}"}],"_postman_id":"ac0b0513-2c7c-442b-a606-004acd9f70f9"},{"name":"advertiser/categories/list","id":"e5eca5e8-0fb4-44a5-9897-6c64b2d6c500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of business categories possible for an advertiser. The id's can be used to set the advertiser category during creation and update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"4e9a5f91-225b-4275-94db-52d4ef823c07","name":"advertiser/categories/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/advertiser/categories/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"categories\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"e5eca5e8-0fb4-44a5-9897-6c64b2d6c500"},{"name":"advertiser/campaign/list","id":"1eaac374-bd93-48a1-a081-565ef6309b46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Returns a list of campaigns for an advertiser based on the id passed in.

\n

Optional request arguments can be passed in for cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"6b343bdf-b75f-4a92-a5f4-757e5c0582e6","name":"advertiser/campaign/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/campaign/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"campaigns\" : [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"objective\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"objective\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"1eaac374-bd93-48a1-a081-565ef6309b46"},{"name":"advertiser/creative/list","id":"5cf81d58-7dda-4e45-9a3d-5dd89b4af3d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

Returns a list of creatives for an advertiser based on the id passed in.

\n

Optional request arguments can be passed in for cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"71d01db7-a4de-4261-81e6-6671ca956100","name":"advertiser/creative/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/creative/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"creatives\" : [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"5cf81d58-7dda-4e45-9a3d-5dd89b4af3d7"},{"name":"advertiser/custom_audience/list","id":"b91b3cc1-4bca-4fba-b6d6-e910dac03ffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

Returns a list of custom audiences for an advertiser based on the id passed in.

\n

Optional request arguments can be passed in for cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"feaaed09-13b2-4f89-828d-8d0d91d41942","name":"advertiser/custom_audience/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/custom_audience/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"advertiser_audiences\" : [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"audience_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"audience_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"b91b3cc1-4bca-4fba-b6d6-e910dac03ffe"},{"name":"advertiser/reporting/scheduled/list","id":"4cedbabc-9e49-4054-8724-0ae0b72d13c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Returns a list of schedueld reports for an advertiser based on the id passed in.

\n

Optional request arguments can be passed in for cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"1c9f2efd-d5a2-4799-b28e-42770360722b","name":"advertiser/reporting/scheduled/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/reporting/scheduled/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"scheduled_reports\": [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"timezone\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"is_archived\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"timezone\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"is_archived\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"4cedbabc-9e49-4054-8724-0ae0b72d13c1"},{"name":"advertiser/reporting/list","id":"b8411f3e-2814-4214-865b-02cb92963eb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"2e754f45-f2fa-4399-9509-1078d914761e","name":"advertiser/reporting/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/advertiser/reportinglist"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\n{\n \"reports\": [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"download_url\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"download_url\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"b8411f3e-2814-4214-865b-02cb92963eb5"},{"name":"advertiser/get//stats","id":"4c805b87-edaf-45d8-af34-b08066f6152b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns delivery stats for a specified advertiser ID, start date, and end date.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"a41d114c-bd54-418f-846a-dbc054ea7139","name":"advertiser/get//stats","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4c805b87-edaf-45d8-af34-b08066f6152b"}],"id":"b25622c3-3c9d-4680-8cfb-34aec7f8f678","_postman_id":"b25622c3-3c9d-4680-8cfb-34aec7f8f678","description":""},{"name":"Campaign","item":[{"name":"campaign/create","id":"e0fef9ff-889f-400f-87fd-a9da008b8b0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer: ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"sub_objective\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

This endpoint creates a campaign with the inputted name and objective.

\n

Valid objective/subobjective values include:

\n
    \n

  • \"AWARENESS\"

    \n
    • \n

  • \"CONSIDERATION\"

    \n
      \n

    • \"WEBSITE_VISITS\"

      \n
      • \n

    • \"LEAD_GENERATION\"

      \n
      • \n
    \n
    • \n

  • \"CONVERSION\"

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"f8d50db7-9f81-480b-95bc-ea8a356ef178","name":"campaign/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"sub_objective\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/campaign/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"objective\": \"\",\n \"sub_objective\": \"\"\n}"}],"_postman_id":"e0fef9ff-889f-400f-87fd-a9da008b8b0f"},{"name":"campaign/update","id":"d678c44c-5778-4301-86c7-ed4675ac1c96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing campaign based on the input payload, where the Campaign id field is required and all other update fields are nullable. The updated campaign object is then returned after a successful update request.

\n

Valid objective values include:

\n
    \n
  • \"AWARENESS\"
    • \n
  • \"CONSIDERATION\"
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"5ee591dc-1565-462b-b7e8-4dddaa5319fe","name":"campaign/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/campaign/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"d678c44c-5778-4301-86c7-ed4675ac1c96"},{"name":"campaign/status/update","id":"df0ba91a-1963-4344-8c1b-4ebd9dc21e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing campaign's user status based on the input, where both the campaign id and the requested status to use are required.

\n

Upon a successful user status update, this method will return the updated campaign object. If the passed in status value is ineligible the endpoint will throw a formatted exception.

\n

Acceptable values for user_status include:

\n
    \n
  • \"ACTIVE\"
    • \n
  • \"PAUSED\"
    • \n
  • \"ARCHIVED\"
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"26a3881f-01fe-4ba8-bc20-afdb3df911b7","name":"campaign/status/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/campaign/status/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"df0ba91a-1963-4344-8c1b-4ebd9dc21e93"},{"name":"campaign/get/","id":"5721d879-925f-4754-a37b-a8c08ca7dbf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns the campaign object based on the id passed in the url.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"534f79d2-42c5-4045-a05f-090506e3f1bd","name":"campaign/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/campaign/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"5721d879-925f-4754-a37b-a8c08ca7dbf5"},{"name":"campaign/get//stats","id":"5830904e-fdf2-4bea-b282-0ee155eed453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns delivery stats for a specified campaign ID, start date, and end date.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"bfe5a1cb-676a-48ec-a6b3-596a0e9ca26f","name":"campaign/get//stats","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5830904e-fdf2-4bea-b282-0ee155eed453"},{"name":"lead_gen/form/list","id":"0a8dea46-dc99-4529-8983-421350a3fe43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

This endpoint returns a list of all the LeadGen Forms owned by the advertiser and the names of the campaigns using the forms. advertiser_id is a required input.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"78a5fdbe-ebe5-457a-b2af-3128b93fce14","name":"lead_gen/form/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"lead_gen_forms\": [\n {\n \"id\": \"\",\n \"campaign_names\": \"\",\n },\n {\n \"id\": \"\",\n \"campaign_names\": \"\",\n },\n}\n"}],"_postman_id":"0a8dea46-dc99-4529-8983-421350a3fe43"}],"id":"4bd33a33-1f08-461b-8f00-a678e5fa6935","_postman_id":"4bd33a33-1f08-461b-8f00-a678e5fa6935","description":""},{"name":"AdGroup","item":[{"name":"adgroup/create","id":"7c1f8133-05bf-48ee-b5f7-0c76fe5ac7bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"custom_audience_ids\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

This endpoint creates an ad group based on the input payload for an existing NAM campaign.

\n

Placements are a required input; valid placement values include:

\n
    \n

  • \"FEED\"

    \n
    • \n

  • \"FS&F\"

    \n
    • \n

  • \"RHR\"

    \n
    • \n
\n

Bid data is a required input; the amount field should be passed in the standardized Money format in order to be parsed correctly, please reference the \"Data Types\" section for more details. Valid pricing_type values include:

\n
    \n
  • \"CPM\"
    • \n
\n

Budget data is a required input; the amount field should be passed in the standardized Money format in order to be parsed correctly, please reference the \"Data Types\" section for more details. Valid budget_type values include:

\n
    \n
  • \"DAILY_CAP_MONEY\"
    • \n
\n

The start_time and end_time fields are required and must be passed in the ZonedDateTime format. Refer to the \"Data Types\" section for more information on standardized date types in the NAM API. If an end_time is not passed in, then the AdGroup is assumed to be running continuously.

\n

Available user_status values for status include:

\n
    \n

  • \"ACTIVE\"

    \n
    • \n

  • \"DRAFT\"

    \n
    • \n

  • \"PAUSED\"

    \n
    • \n
\n

Frequency cap configurations, targeting, and custom audience ids configuration are all optional inputs for this method as well.

\n

Eligible timeunit values for frequency cap configurations include:

\n
    \n

  • \"MINUTE\"

    \n
    • \n

  • \"MINUTES\"

    \n
    • \n

  • \"HOUR\"

    \n
    • \n

  • \"HOURS\"

    \n
    • \n

  • \"DAY\"

    \n
    • \n

  • \"DAYS\"

    \n
    • \n

  • \"WEEK\"

    \n
    • \n

  • \"WEEKS\"

    \n
    • \n

  • \"MONTH\"

    \n
    • \n

  • \"MONTHS\"

    \n
    • \n
\n

Targeting is an optional input, and specified by IDs. The IDs for each targeting category can be retrieved via the targeting/ GET endpoints (see the \"Targeting\" section), or custom_audience/get/ for custom audiences.

\n
    \n

  • included_location_targeting_ids: IDs of all locations to include in targeting

    \n
    • \n

  • excluded_location_targeting_ids:IDs of all locations to exclude from targeting

    \n
    • \n

  • audience_targeting_ids: IDs of all demographics and/or devices to include in targeting

    \n
    • \n

  • custom_audience_targeting:Boolean criteria for targeting custom audiences

    \n
      \n

    • include: Lists of lists of IDs to include in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = (1 OR 2) AND (3)
        • \n
      \n
      • \n

    • exclude: Lists of lists of IDs to exclude in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = NOT ((1 OR 2) AND (3))
        • \n
      \n
      • \n
    \n
    • \n

  • interests_targeting:Boolean criteria for targeting interests

    \n
      \n

    • include: Lists of lists of IDs to include in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = (1 OR 2) AND (3)
        • \n
      \n
      • \n

    • exclude: Lists of lists of IDs to exclude from targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = NOT ((1 OR 2) AND (3))
        • \n
      \n
      • \n
    \n
    • \n
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"8d7b2daa-6215-4b1d-a6ae-569be0574b47","name":"adgroup/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"placements\": [\n \"\"\n ],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/adgroup/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"7c1f8133-05bf-48ee-b5f7-0c76fe5ac7bd"},{"name":"adgroup/update","id":"a807a354-e9f1-48a5-bdbb-e255cb9db042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"adgroup_id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": {\n \"value\": \"\"\n },\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n}","options":{"raw":{"language":"json"}}},"url":"","description":"

Updates an existing ad group based on the input payload, where the adgroup_id and advertiser_id fields are required and all other update fields are nullable. The updated campaign object is then returned after a successful update request.

\n

If bid data is updated, the amount field should be passed in the standardized Money format in order to be parsed correctly, please reference the \"Data Types\" section for more details. Valid pricing_type values include:

\n
    \n
  • \"CPM\"
    • \n
\n

if budget data is updated, the amount field should be passed in the standardized Money format in order to be parsed correctly, please reference the \"Data Types\" section for more details. Valid budget_type values include:

\n
    \n
  • \"DAILY_CAP_MONEY\"
    • \n
\n

if an Ad Group is created in \"DRAFT\" status, it can be published by updating the status to \"ACTIVE\"

\n

The start_time and end_time fields can be updated and must be passed in ZonedDateTime format. Refer to the \"Data Types\" section for more information on standardized date types in the NAM API.

\n

Updating an end_time can mean either setting an explicit ending time or passing in an explicit null to signify this AdGroup should now be running continuously.

\n

Eligible timeunit values for frequency cap configurations include:

\n
    \n

  • \"MINUTE\"

    \n
    • \n

  • \"MINUTES\"

    \n
    • \n

  • \"HOUR\"

    \n
    • \n

  • \"HOURS\"

    \n
    • \n

  • \"DAY\"

    \n
    • \n

  • \"DAYS\"

    \n
    • \n

  • \"WEEK\"

    \n
    • \n

  • \"WEEKS\"

    \n
    • \n

  • \"MONTH\"

    \n
    • \n

  • \"MONTHS\"

    \n
    • \n
\n

Targeting is an optional input, and specified by IDs. The IDs for each targeting category can be retrieved via the targeting/ GET endpoints (see the \"Targeting\" section), or custom_audience/get/ for custom audiences.

\n
    \n

  • included_location_targeting_ids: IDs of all locations to include in targeting

    \n
    • \n

  • excluded_location_targeting_ids:IDs of all locations to exclude from targeting

    \n
    • \n

  • audience_targeting_ids: IDs of all demographics and/or devices to include in targeting

    \n
    • \n

  • custom_audience_targeting:Boolean criteria for targeting custom audiences

    \n
      \n

    • include: Lists of lists of IDs to include in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = (1 OR 2) AND (3)
        • \n
      \n
      • \n

    • exclude: Lists of lists of IDs to exclude in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = NOT ((1 OR 2) AND (3))
        • \n
      \n
      • \n
    \n
    • \n

  • interests_targeting:Boolean criteria for targeting interests

    \n
      \n

    • include: Lists of lists of IDs to include in targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = (1 OR 2) AND (3)
        • \n
      \n
      • \n

    • exclude: Lists of lists of IDs to exclude from targeting. Within each inner list, audiences are OR'd. Inner lists are then AND'd together.

      \n
        \n
      • Ex) [[1,2][3]] = NOT ((1 OR 2) AND (3))
        • \n
      \n
      • \n
    \n
    • \n
\n

Note that the placements of an AdGroup cannot be updated once they are initially set during the creation process.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"bf88d544-5744-4322-83bb-98af90e06d45","name":"adgroup/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"adgroup_id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": {\n \"value\": \"\"\n },\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/adgroup/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"a807a354-e9f1-48a5-bdbb-e255cb9db042"},{"name":"adgroup/status/update","id":"e1334c15-c798-483b-9c8b-8d69a6f90caa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing adgroup's user status based on the input, where both the adgroup id and the requested status to use are required.

\n

Valid values for user_status include:

\n
    \n
  • \"ACTIVE\"
    • \n
  • \"PAUSED\"
    • \n
  • \"ARCHIVED\"
    • \n
\n

Upon a successful user status update, this method will return the updated adgroup object. If the passed in status value is ineligible the endpoint will throw a formatted exception.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"51c9bbd4-cfde-4b01-aa2e-70b02b5b73a7","name":"adgroup/status/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/adgroup/status/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"custom_audience_ids\": [\"\"],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"e1334c15-c798-483b-9c8b-8d69a6f90caa"},{"name":"adgroup/get/","id":"93d9e58e-d40c-425d-a5fa-bf9ff4c883f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns the adgroup object based on the id passed in the url.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"0cd9a056-6775-42ce-8b53-1f0e3de2dbdc","name":"adgroup/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/adgroup/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"custom_audience_ids\": [\"\"],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"93d9e58e-d40c-425d-a5fa-bf9ff4c883f9"},{"name":"adgroup/list","id":"52481ee9-5dcd-4a9b-85dc-c392571d6863","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint returns a paginated list of AdGroup(s) for a given Campaign id; both advertiser_id and campaign_id are required inputs while pagination_parameters are optional.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"138b1450-fdb3-47c9-8b8c-84ac8c559bdd","name":"adgroup/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/adgroup/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"adgroups\" : [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"custom_audience_targeting\": {\n \"include\": [[\", \"],[\"\"]],\n \"exclude\": [[\"\"]]\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"custom_audience_ids\": [\"\"],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"campaign_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"placements\": [\"\"],\n \"bid\": {\n \"amount\": \"\",\n \"pricing_type\": \"\"\n },\n \"budget\": {\n \"amount\": \"\",\n \"budget_type\": \"\"\n },\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"frequency_caps\": [\n {\n \"max_impressions\": \"\",\n \"num_timeunits\": \"\",\n \"timeunit\": \"\"\n }\n ],\n \"targeting\": {\n \"included_location_targeting_ids\": [\"\"],\n \"excluded_location_targeting_ids\": [\"\"],\n \"audience_targeting_ids\": [\"\"],\n \"interests_targeting\": {\n \"include\": [],\n \"exclude\": []\n },\n \"custom_audience_targeting\": {\n \"include\": [],\n \"exclude\": []\n },\n \"time_of_day\": {\n \"included\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ],\n \"excluded\": [\n {\n \"days\": [\"\"],\n \"time\": {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n }\n ]\n }\n }, \n \"custom_audience_ids\": [\"\"],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"52481ee9-5dcd-4a9b-85dc-c392571d6863"},{"name":"adgroup/get//stats","id":"54c6ca9f-0d38-48d8-a2cb-415bb94117b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns delivery stats for a specified Ad Group ID, start date, and end date.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"4666f330-31ae-42da-bcc8-ceade5197f60","name":"adgroup/get//stats","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"54c6ca9f-0d38-48d8-a2cb-415bb94117b2"}],"id":"63f9c729-4b4f-4d14-805c-766971e9eeb4","_postman_id":"63f9c729-4b4f-4d14-805c-766971e9eeb4","description":""},{"name":"Ad","item":[{"name":"ad/create","id":"77835432-86d8-4c1a-b554-b855a165aa70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint creates an ad based on the input payload for an existing NAM ad group.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"6cea086d-3957-432d-93c2-d94f2f844e90","name":"ad/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/ad/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"77835432-86d8-4c1a-b554-b855a165aa70"},{"name":"ad/update","id":"1f290e1e-1569-4a7a-b805-373634da6004","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"creative_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing ad based on the input payload, where the id and advertiser_id fields are required while all other update fields are nullable. The updated ad object is then returned after a successful update request.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"df1ae8a7-37b0-45e7-aaaa-d40d4ff29ac4","name":"ad/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"creative_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/ad/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"1f290e1e-1569-4a7a-b805-373634da6004"},{"name":"ad/status/update","id":"589326f5-6261-4d0b-990a-0d189d4c4fee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing ad's user status based on the input, where both the ad id and the requested status to use are required.

\n

Upon a successful user status update, this method will return the updated ad object. If the passed in status value is ineligible the endpoint will throw a formatted exception.

\n

Valid values for user_status include:

\n
    \n
  • \"ACTIVE\"
    • \n
  • \"INACTIVE\"
    • \n
  • \"ARCHIVED\"
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"e224a5af-c0ed-4373-b08b-d8f5fa08e779","name":"ad/status/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/ad/status/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"589326f5-6261-4d0b-990a-0d189d4c4fee"},{"name":"ad/get/","id":"d9d4acfc-d63c-4df5-a661-1d0740a11635","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns the ad object based on the id passed in the url.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"da384c5a-075a-4386-b23e-85c4941388f3","name":"ad/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/ad/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"d9d4acfc-d63c-4df5-a661-1d0740a11635"},{"name":"ad/list","id":"687d5c29-c3db-4887-a3ea-6a2b1db276d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

This endpoint returns a paginated list of Ad(s) for a given AdGroup; both advertiser_id and adgroup_id are required inputs while pagination_parameters are optional.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"d679407d-02bb-49ed-a82c-a5276ce02c03","name":"ad/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/ad/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ads\": [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"adgroup_id\": \"\",\n \"creative_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"user_status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"687d5c29-c3db-4887-a3ea-6a2b1db276d8"},{"name":"ad/get//stats","id":"22c442d4-a4a4-4f76-bfe3-7bc83b910f99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns delivery stats for a specified ad ID, start date, and end date.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"e315e370-a0ba-4263-aa4c-8aeec2ef9c08","name":"ad/get//stats","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22c442d4-a4a4-4f76-bfe3-7bc83b910f99"}],"id":"bd3c8b9b-6f52-41ac-8e2a-a77acb2fe3f5","_postman_id":"bd3c8b9b-6f52-41ac-8e2a-a77acb2fe3f5","description":""},{"name":"Audiences","item":[{"name":"custom_audience/create","id":"406a1dae-f86c-4b50-9ac1-1187f34ba01c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer: ","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"advertiser_id","value":"\"\"","type":"text"},{"key":"audience_name","value":"\"\"","type":"text"},{"key":"audience_description","value":"\"\"","type":"text"},{"key":"file","type":"file","value":null}]},"url":"https://ads.nextdoor.com/v2/api/custom_audience/create","description":"

This endpoint is used to create an audience by data file. The data file is uploaded via form-data sent in the body of the request. The audience is only successfully created if the data in the file_path corresponds with the expected format.

\n

Specifically, the audience data must match a supported audience type. Each audience type requires a matching set of column headers in the uploaded CSV file. Valid audience types with their required corresponding header columns include:

\n
    \n

  • ADDRESSES

    \n
      \n

    • street_number (aliases = \"street_number\", \"street_nbr\", \"street_num\")

      \n
      • \n

    • route (aliases = \"street_name\", \"street\", \"route\")

      \n
      • \n

    • unit_number (aliases = \"unit_number\", \"unit_num\", \"unit_nbr\")

      \n
      • \n

    • city (aliases = \"city\", \"cty\")

      \n
      • \n

    • state (aliases = \"state\")

      \n
      • \n

    • postal_code (aliases = \"postal_code\", \"zip_code\", \"zip\", \"postal\", \"postal_codes\")

      \n
      • \n
    \n
    • \n

  • EMAIL_AND_ADDRESSES

    \n
      \n

    • email (aliases = \"email\", \"email_address\")

      \n
      • \n

    • street_number (aliases = \"street_number\", \"street_nbr\", \"street_num\")

      \n
      • \n

    • route (aliases = \"street_name\", \"street\", \"route\")

      \n
      • \n

    • unit_number (aliases = \"unit_number\", \"unit_num\", \"unit_nbr\")

      \n
      • \n

    • city (aliases = \"city\", \"cty\")

      \n
      • \n

    • state (aliases = \"state\")

      \n
      • \n

    • postal_code (aliases = \"postal_code\", \"zip_code\", \"zip\", \"postal\", postal_codes\")

      \n
      • \n
    \n
    • \n

  • EMAILS

    \n
      \n
    • email (aliases = \"email\", \"email_address\")
      • \n
    \n
    • \n

  • POSTAL_CODES

    \n
      \n
    • postal_code (aliases = \"postal_code\", \"zip_code\", \"zip\", \"postal\", \"postal_codes\")
      • \n
    \n
    • \n

  • USER_PROFILE_SKS

    \n
      \n
    • user_profile_sk (aliases = \"user_profile_sk\", \"user_id\", \"user_profile_id\")
      • \n
    \n
    • \n
\n

where aliases refer to string names which we consider equivalent to each other and are thus classified to the same column header name.

\n

NOTE: filename must only be alphanumeric characters, underscores ('_') and be of the .csv filetype.

\n","urlObject":{"protocol":"https","path":["v2","api","custom_audience","create"],"host":["ads","nextdoor","com"],"query":[],"variable":[]}},"response":[{"id":"c337df9e-ce38-4f2f-8cdb-a63629df3a68","name":"custom_audience/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer: ","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"advertiser_id","value":"\"\"","type":"text"},{"key":"audience_name","value":"\"\"","type":"text"},{"key":"audience_description","value":"\"\"","type":"text"},{"key":"file","type":"file","value":null}]},"url":"https://ads.nextdoor.com/v2/api/custom_audience/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"id\": \"\",\n\"advertiser_id\": \"\",\n\"name\": \"\",\n\"description\": \"\",\n\"audience_type\": \"\",\n\"created_at\": \"\",\n\"updated_at\": \"\"\n}\n"}],"_postman_id":"406a1dae-f86c-4b50-9ac1-1187f34ba01c"},{"name":"custom_audience/get/","id":"bcbc128c-798c-4746-8e20-18346841d4e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://ads.nextdoor.com/v2/api/custom_audience/get/","description":"

This endpoint returns an audience object based on the id passed in the URL. The id parameter specifies the audience.

\n","urlObject":{"protocol":"https","path":["v2","api","custom_audience","get",""],"host":["ads","nextdoor","com"],"query":[],"variable":[]}},"response":[{"id":"aa346b67-13f0-4991-ad08-c62b18ebc0a8","name":"custom_audience/get","originalRequest":{"method":"GET","header":[],"url":"https://ads.nextdoor.com/v2/api/custom_audience/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"id\": \"\",\n\"advertiser_id\": \"\",\n\"name\": \"\",\n\"description\": \"\",\n\"audience_type\": \"\",\n\"created_at\": \"\",\n\"updated_at\": \"\"\n}"}],"_postman_id":"bcbc128c-798c-4746-8e20-18346841d4e7"},{"name":"custom_audience/archive","id":"8e1a4ab8-392d-43ca-8703-c2521509c67e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"

This endpoint archives the custom audience that is specified in the request (the audience is identified by its ID).

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"8efeb18a-f880-413b-bcb8-5017cf03399b","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/custom_audiences/archive"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\"id\": \"\",\n\"advertiser_id\": \"\",\n\"name\": \"\",\n\"description\": \"\",\n\"audience_type\": \"\",\n\"created_at\": \"\",\n\"updated_at\": \"\"\n}\n"}],"_postman_id":"8e1a4ab8-392d-43ca-8703-c2521509c67e"},{"name":"custom_audience/retargeting/create","id":"f12c4fa8-d250-46bf-8615-57d7de523729","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"audience_name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"retargeting_data\": {\n \"lookback_window_ms\": \"\",\n \"enagagement_retargeting_data\": {\n \"enagagement_actions\": [\n {\n \"entity_id_type\": \"\",\n \"entity_id\": \"\",\n \"enagagement_action\": \"\"\n }\n ]\n },\n \"pixel_retargeting_data\": {\n \"pixel_id\": \"\",\n \"pixel_actions\": [\"\", \"\"]\n },\n \"capi_retargeting_data\": {\n \"entity_id_type\": \"\",\n \"entity_id\": \"\",\n \"capi_actions\": [\"\", \"\"]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/create","urlObject":{"protocol":"https","path":["v2","api","custom_audience","retargeting","create"],"host":["ads","nextdoor","com"],"query":[],"variable":[]}},"response":[{"id":"a40dd30a-8387-41f1-8465-0a9c7bbe0063","name":"custom_audience/retargeting/create","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"audience_name\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"retargeting_data\": {\n \"lookback_window_ms\": \"\",\n \"enagagement_retargeting_data\": {\n \"enagagement_actions\": [\n {\n \"entity_id_type\": \"\",\n \"entity_id\": \"\",\n \"enagagement_action\": \"\"\n }\n ]\n },\n \"pixel_retargeting_data\": {\n \"pixel_id\": \"\",\n \"pixel_actions\": [\"\", \"\"]\n },\n \"capi_retargeting_data\": {\n \"entity_id_type\": \"\",\n \"entity_id\": \"\",\n \"capi_actions\": [\"\", \"\"]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/create"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"advertiser_id\": \"1234\",\n \"audience_name\": \"Test\",\n \"description\": \"Testing retargeting audience\",\n \"type\": \"RETARGETING_ENGAGEMENT\",\n \"retargeting_data\": {\n \"lookback_window_ms\": \"8640000\",\n \"enagagement_retargeting_data\": {\n \"enagagement_actions\": [\n {\n \"entity_id_type\": \"CAMPAIGN\",\n \"entity_id\": \"00000\",\n \"enagagement_action\": \"CLICK\"\n },\n {\n \"entity_id_type\": \"AD_GROUP\",\n \"entity_id\": \"11111\",\n \"enagagement_action\": \"SEEN\"\n }\n ]\n }\n }\n}"}],"_postman_id":"f12c4fa8-d250-46bf-8615-57d7de523729"},{"name":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/get/","id":"59851202-3368-4fe6-ab3a-e94f748960f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/get/","urlObject":{"protocol":"https","path":["v2","api","custom_audience","retargeting","get",""],"host":["ads","nextdoor","com"],"query":[],"variable":[]}},"response":[{"id":"c5cee8db-8bb8-47bd-92bf-7430aed687a0","name":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/get/","originalRequest":{"method":"GET","header":[],"url":"https://ads.nextdoor.com/v2/api/custom_audience/retargeting/get/12345678"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"59851202-3368-4fe6-ab3a-e94f748960f4"}],"id":"bbaf8f6f-e9c5-4564-9105-4c420db4502d","_postman_id":"bbaf8f6f-e9c5-4564-9105-4c420db4502d","description":""},{"name":"Creative","item":[{"name":"creative/create","id":"3ea01dac-0b2a-4dec-aa50-f0e6fc0acfe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint creates a creative based on the input payload; this requires using images that have already been uploaded to NAM.

\n

All fields are required except the following:

\n
    \n

  • offerText

    \n
    • \n

  • price

    \n
    • \n

  • impressionTrackingUrls

    \n
    • \n

  • clickTrackingUrls

    \n
    • \n
\n

All new Creatives are subject to review with an SLA of 24 hours for a response.

\n

Valid placement values include:

\n
    \n

  • \"NEWSFEED\"

    \n
    • \n

  • \"FSF\"

    \n
    • \n

  • \"RHR\"

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"0fab9fe1-0fe1-4108-8f92-e2cd0a481c80","name":"creative/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"3ea01dac-0b2a-4dec-aa50-f0e6fc0acfe1"},{"name":"creative/create (Video)","id":"972ea638-3b5a-4218-bb11-63632d7b00f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"video_template_input\": {\n \"video_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint creates a video creative based on the input payload; this requires using videos that have already been uploaded to NAM.

\n

All fields are required except the following:

\n
    \n

  • offerText

    \n
    • \n

  • price

    \n
    • \n

  • impressionTrackingUrls

    \n
    • \n

  • clickTrackingUrls

    \n
    • \n
\n

All new Creatives are subject to review with an SLA of 24 hours for a response.

\n

Valid placement values include:

\n
    \n
  • \"FEED\"
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"0f13dc8b-73e9-4d57-8eed-e5342baeb948","name":"creative/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"video_template_input\": {\n \"video_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"video_template_input\": {\n \"video_id\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"972ea638-3b5a-4218-bb11-63632d7b00f9"},{"name":"creative/create (Carousel)","id":"9b10f722-a40e-4cca-b156-b3a01e6b360a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"feed_carousel_template_input\": {\n \"cards\": [\n { \n \"slot_index\": \"\",\n \"media_type\": \"\",\n \"clickthrough_url\": \"\",\n \"cta\": \"\",\n \"offer_text\": \"\",\n \"image_upload_id\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint creates a carousel creative based on the input payload; this requires using images that have already been uploaded to NAM.

\n

All fields are required except the following:

\n
    \n

  • impressionTrackingUrls

    \n
    • \n

  • clickTrackingUrls

    \n
    • \n
\n

All new Creatives are subject to review with an SLA of 24 hours for a response.

\n

Valid placement values include:

\n
    \n
  • \"FEED\"
    • \n
\n

Valid media type values include:

\n
    \n

  • \"IMAGE\"

    \n
    • \n

  • \"VIDEO\"

    \n
    • \n
\n

Up to 5 cards can be included.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"9eb20e27-1772-42f6-8bd2-88c9b9993b84","name":"creative/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"feed_carousel_template_input\": {\n \"cards\": [\n { \n \"slot_index\": \"\",\n \"media_type\": \"\",\n \"clickthrough_url\": \"\",\n \"cta\": \"\",\n \"offer_text\": \"\",\n \"image_upload_id\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"feed_carousel_template_input\": {\n \"cards\": [\n { \n \"slot_index\": \"\",\n \"media_type\": \"\",\n \"clickthrough_url\": \"\",\n \"cta\": \"\",\n \"offer_text\": \"\",\n \"image_upload_id\": \"\"\n }\n ]\n }\n}"}],"_postman_id":"9b10f722-a40e-4cca-b156-b3a01e6b360a"},{"name":"creative/create (PFQ Lead-gen)","id":"6a370b36-6070-4510-a13f-02e402bf26f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"pfq_template_input\": {\n \"lead_gen_form\": {\n \"fields\": [ \n {\n \"label\": \"\",\n \"type\": \"\",\n \"required\": \"\"\n }\n ],\n \"privacy_policy_link\": \"\",\n \"post_submit_properties\": {\n \"title\": \"\",\n \"message\": \"\",\n \"cta\": {\n \"text\": \"\",\n \"url\": \"\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This endpoint creates a prefilled question lead-gen creative based on the input payload; this requires using images that have already been uploaded to NAM.

\n

All fields are required except the following:

\n
    \n

  • impressionTrackingUrls

    \n
    • \n

  • clickTrackingUrls

    \n
    • \n
\n

All new Creatives are subject to review with an SLA of 24 hours for a response.

\n

Valid placement values include:

\n
    \n
  • \"FEED\"
    • \n
\n

valid field types include:

\n
    \n

  • \"NAME\"

    \n
    • \n

  • \"ADDRESS\"

    \n
    • \n

  • \"EMAIL\"

    \n
    • \n

  • \"PHONE_NUMBER\"

    \n
    • \n

  • \"ZIPCODE\"

    \n
    • \n

  • \"CUSTOM\"

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"1c19fa1d-a7d9-4c4a-855b-ecb39658ede4","name":"creative/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"pfq_template_input\": {\n \"lead_gen_form\": {\n \"fields\": [ \n {\n \"label\": \"\",\n \"type\": \"\",\n \"required\": \"\"\n }\n ],\n \"privacy_policy_link\": \"\",\n \"post_submit_properties\": {\n \"title\": \"\",\n \"message\": \"\",\n \"cta\": {\n \"text\": \"\",\n \"url\": \"\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"pfq_template_input\": {\n \"lead_gen_form\": {\n \"fields\": [ \n {\n \"label\": \"\",\n \"type\": \"\",\n \"required\": \"\"\n }\n ],\n \"privacy_policy_link\": \"\",\n \"post_submit_properties\": {\n \"title\": \"\",\n \"message\": \"\",\n \"cta\": {\n \"text\": \"\",\n \"url\": \"\"\n }\n }\n }\n }\n}"}],"_postman_id":"6a370b36-6070-4510-a13f-02e402bf26f6"},{"name":"creative/update","id":"5677c87d-5670-4772-b923-87bcfe1e42a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing creative based on the input payload. The id and advertiser_id fields are required while all other update fields are nullable. The updated creative object is then returned after a successful update request.

\n

When a creative is updated, it is subject to a review processs with a 24 hour SLA similar to when a creative is first made.

\n

Note: The placement of a creative cannot be changed.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"25a16179-eef6-4629-8213-4b766ba3118b","name":"creative/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"5677c87d-5670-4772-b923-87bcfe1e42a5"},{"name":"creative/update (Video)","id":"e91a8102-87fc-4ba3-ac86-c2f1b005e35b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"video_template_input\": {\n \"video_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing creative based on the input payload. The id and advertiser_id fields are required while all other update fields are nullable. The updated creative object is then returned after a successful update request.

\n

When a creative is updated, it is subject to a review processs with a 24 hour SLA similar to when a creative is first made.

\n

Note: The placement of a creative cannot be changed.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"7b70583d-2239-43f1-9cfb-fccb6bffc74f","name":"creative/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"video_template_input\": {\n \"video_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"e91a8102-87fc-4ba3-ac86-c2f1b005e35b"},{"name":"creative/update (Carousel)","id":"bc5833cc-1b2c-4696-bc16-179c576c7a20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"feed_carousel_template_input\": {\n \"cards\": [\n { \n \"slot_index\": \"\",\n \"media_type\": \"\",\n \"clickthrough_url\": \"\",\n \"cta\": \"\",\n \"offer_text\": \"\",\n \"image_upload_id\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing creative based on the input payload. The id and advertiser_id fields are required while all other update fields are nullable. The updated creative object is then returned after a successful update request.

\n

When a creative is updated, it is subject to a review processs with a 24 hour SLA similar to when a creative is first made.

\n

Note: The placement of a creative cannot be changed.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"4187f456-7502-49af-a620-a4204590fa97","name":"creative/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"cta\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"feed_carousel_template_input\": {\n \"cards\": [\n { \n \"slot_index\": \"\",\n \"media_type\": \"\",\n \"clickthrough_url\": \"\",\n \"cta\": \"\",\n \"offer_text\": \"\",\n \"image_upload_id\": \"\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"bc5833cc-1b2c-4696-bc16-179c576c7a20"},{"name":"creative/update (PFQ Lead-gen)","id":"81fb6530-5de8-4aab-bf5c-34909385a8cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"pfq_template_input\": {\n \"lead_gen_form\": {\n \"fields\": [ \n {\n \"label\": \"\",\n \"type\": \"\",\n \"required\": \"\"\n }\n ],\n \"privacy_policy_link\": \"\",\n \"post_submit_properties\": {\n \"title\": \"\",\n \"message\": \"\",\n \"cta\": {\n \"text\": \"\",\n \"url\": \"\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing creative based on the input payload. The id and advertiser_id fields are required while all other update fields are nullable. The updated creative object is then returned after a successful update request.

\n

When a creative is updated, it is subject to a review processs with a 24 hour SLA similar to when a creative is first made.

\n

Note: The placement of a creative cannot be changed.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"60884fad-e7b7-48a8-9ab8-da1d1ced9f02","name":"creative/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\",\n \"advertiser_id\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"cta\": \"\",\n \"canvas_image_id\": \"\",\n \"logo_image_id\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"pfq_template_input\": {\n \"lead_gen_form\": {\n \"fields\": [ \n {\n \"label\": \"\",\n \"type\": \"\",\n \"required\": \"\"\n }\n ],\n \"privacy_policy_link\": \"\",\n \"post_submit_properties\": {\n \"title\": \"\",\n \"message\": \"\",\n \"cta\": {\n \"text\": \"\",\n \"url\": \"\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"81fb6530-5de8-4aab-bf5c-34909385a8cd"},{"name":"creative/status/update","id":"cf5d6133-af61-47ec-a855-0907fecec310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Updates an existing creative's user status based on the passed in advertiser id, creative id, and requested user status. The only supported user status for this endpont is \"ARCHIVED\".

\n

Upon a successful user status update, this method will return the updated creative object. If the passed in status value is ineligible the endpoint will throw a formatted exception.

\n

Note that a Creative can only be archived only if it is not currently in use by any Ad(s).

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"87039f1e-b8df-47ce-9849-28ad8941f19a","name":"creative/status/update","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"user_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"ads.nextdoor.com/v2/api/creative/status/update"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"cf5d6133-af61-47ec-a855-0907fecec310"},{"name":"creative/get/","id":"37aae35a-7019-436f-8570-ec45442d85ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns the creative object based on the id passed in the url.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"c42c1b53-2c16-42d7-9de6-1c086f7a77f7","name":"creative/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"ads.nextdoor.com/v2/api/creative/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"placement\": \"\",\n \"advertiser_name\": \"\",\n \"headline\": \"\",\n \"body_text\": \"\",\n \"offer_text\": \"\",\n \"price\": \"\",\n \"cta\": \"\",\n \"canvas_image_url\": \"\",\n \"logo_image_url\": \"\",\n \"clickthrough_url\": \"\",\n \"impression_tracking_urls\": [\n \"\"\n ],\n \"click_tracking_urls\": [\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"37aae35a-7019-436f-8570-ec45442d85ef"},{"name":"creative/get//stats","id":"2c5daf42-c6ef-4f27-8b62-d39f61e57fe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns delivery stats for a specified creative ID, start date, and end date.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"8664e8a5-8e1e-489d-b291-78048c1617f9","name":"creative/get//stats","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2c5daf42-c6ef-4f27-8b62-d39f61e57fe9"}],"id":"c7134ad3-462a-469d-a82f-fdb2250170ab","_postman_id":"c7134ad3-462a-469d-a82f-fdb2250170ab","description":""},{"name":"Media","item":[{"name":"media/logo/upload","id":"22c5dd41-900c-438a-8708-af9ffdd8db9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"advertiser_id","value":"adsId","description":"

required

\n","type":"text"},{"key":"file","description":"

required

\n","type":"file","value":null},{"key":"file_name","value":"String","description":"

required

\n","type":"text"}]},"url":"","description":"

Uploads an image to NAM so it can be used as a logo image for a creative.

\n

The image must have a 1:1 ratio and comply to the logo image specifications of x.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"048c187d-14f6-4382-bfd4-1a0b6c442276","name":"media/logo/upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"advertiser_id","value":"","type":"text"},{"key":"file_name","value":"","type":"text"}],"options":{"raw":{"language":"text"}}},"url":"https://ads.nextdoor.com/v2/api/media/logo/upload"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\" : \"\",\n \"file_name\": \"\",\n \"public_url\": \"\",\n \"mime_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"22c5dd41-900c-438a-8708-af9ffdd8db9b"},{"name":"media/canvas/upload","id":"6fbafb16-cdf7-4a92-9a5a-cdea959b0dbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"advertiser_id","value":"adsId","description":"

required

\n","type":"text"},{"key":"placement","value":"String","description":"

optional - Allowed values are (RHR,FEED,FSF). if not specified, default to FEED

\n","type":"text"},{"key":"file","description":"

required

\n","type":"file","value":null},{"key":"file_name","value":"String","description":"

required

\n","type":"text"}]},"description":"

Uploads an image, based on the file, to NAM so it can be used as a canvas image for a creative.

\n

By default, the api will validate whether the image uploaded is compliant with the \"FEED\" placement specification. To validate against another placement, the placment field can be passed in to the request.

\n

The specification requirements per placement are outlined below:

\n
    \n
  • \"FEED\" - ~16:9 aspect ratio with a max width/height of 2626 x 1375 pixels.
    • \n
  • \"FS&F\" - ~1:1 aspect ratio with a max width/height of 1000 x 983 pixels.
    • \n
  • \"RHR\" - 1:1 aspect ratio with a max width/height of 1900 x 1900 pixels.
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"c0455a5c-f42e-4ad7-a7fa-1362776ff378","name":"media/canvas/upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"advertiser_id","value":"","type":"text"},{"key":"file_name","value":"","type":"text"},{"key":"placement","value":"","type":"text"}]},"url":"https://ads.nextdoor.com/v2/api/media/canvas/upload"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\" : \"\",\n \"file_name\": \"\",\n \"public_url\": \"\",\n \"mime_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"6fbafb16-cdf7-4a92-9a5a-cdea959b0dbc"},{"name":"media/video/upload","id":"b673c2f3-ccca-457f-8f26-112b5567992e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"advertiser_id","value":"adsId","description":"

required

\n","type":"text"},{"key":"file","description":"

required

\n","type":"file","value":null},{"key":"file_name","value":"String","description":"

required

\n","type":"text"}]},"description":"

Uploads a video, based on the file to NAM so it can be used for a creative.

\n

The specification requirements are outlined below:

\n
    \n

  • Max video size: 500mb

    \n
    • \n

  • Max file name character count: 200

    \n
    • \n

  • Aspect ratio 16:9

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"721c8a91-4064-4c7b-af6e-3c618d29e20c","name":"media/video/upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"advertiser_id","value":"","type":"text"},{"key":"file_name","value":"","type":"text"},{"key":"placement","value":"","type":"text"}]},"url":"https://ads.nextdoor.com/v2/api/media/video/upload"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\" : \"\",\n \"file_name\": \"\",\n \"public_url\": \"\",\n \"mime_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"b673c2f3-ccca-457f-8f26-112b5567992e"},{"name":"media/image/get/","id":"1f564034-7c9a-41e1-9d0a-70d2e976b21d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Returns the media image based on the id passed in the url.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"0125ca5e-544d-4d79-bbbd-4e62c85f064f","name":"media/image/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"ads.nextdoor.com/v2/api/media/image/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\" : \"\",\n \"file_name\": \"\",\n \"public_url\": \"\",\n \"mime_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}"}],"_postman_id":"1f564034-7c9a-41e1-9d0a-70d2e976b21d"}],"id":"e0b24d40-dbef-487f-9cad-37c27f4059b4","_postman_id":"e0b24d40-dbef-487f-9cad-37c27f4059b4","description":""},{"name":"Reporting","item":[{"name":"reporting/create","id":"c52ea3fb-ea37-4b0b-afea-eb841c2ac032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"start_time\": \"\",\n \"end_time\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Creates an ad hoc report in NAM based on the input configuration. A successful creation will result in a report being generated and sent to the recipient emails.

\n

The \"start_time\" and \"end_time\" fields are required and must be passed in ISO 6801 format. Refer to the \"Data Types\" section for more information on standardized date types in the NAM API.

\n

Acceptable values for \"dimesion_granularity\" include:

\n
    \n

  • \"CAMPAIGN\"

    \n
    • \n

  • \"AD_GROUP\"

    \n
    • \n

  • \"AD\"

    \n
    • \n

  • \"PLACEMENT\"

    \n
    • \n
\n

Acceptable values for \"time_granularity\" include:

\n
    \n

  • \"DAY\"

    \n
    • \n

  • \"WEEK\"

    \n
    • \n

  • \"MONTH\"

    \n
    • \n
\n

Acceptable values for \"metrics\" include:

\n
    \n

  • \"CLICKS\"

    \n
    • \n

  • \"IMPRESSIONS\"

    \n
    • \n

  • \"CTR\"

    \n
    • \n

  • \"CONVERSIONS\"

    \n
    • \n

  • \"SPEND\"

    \n
    • \n

  • \"CPM\"

    \n
    • \n

  • \"CPC\"

    \n
    • \n

  • \"BILLABLE_SPEND\"

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"4279f5f7-272c-48c5-856e-dd8c972f6ad0","name":"reporting/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"start_time\": \"\",\n \"end_time\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/reporting/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"download_url\": \"\"\n}"}],"_postman_id":"c52ea3fb-ea37-4b0b-afea-eb841c2ac032"},{"name":"reporting/get/","id":"96fcf640-6b62-4abc-9aab-398efe78051a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Get a report on NAM based on the id passed in the request url.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"892f15c1-5557-480e-91fa-3593a1e7e98d","name":"reporting/get/","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/reporting/get/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"download_url\": \"\"\n}"}],"_postman_id":"96fcf640-6b62-4abc-9aab-398efe78051a"},{"name":"reporting/scheduled/create","id":"58c084b6-35a5-41c8-90bb-8a76aed5fee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"description":"

Creates a scheduled report based on the input configuration. Upon a successful request the report will be sent out based on the schedule cadence.

\n

Acceptable values for \"schedule\" include:

\n
    \n

  • \"DAILY\"

    \n
    • \n

  • \"WEEKLY\"

    \n
    • \n

  • \"MONTHLY\"

    \n
    • \n

  • \"QUARTERLY\"

    \n
    • \n
\n

Acceptable values for \"dimesion_granularity\" include:

\n
    \n

  • \"CAMPAIGN\"

    \n
    • \n

  • \"AD_GROUP\"

    \n
    • \n

  • \"AD\"

    \n
    • \n

  • \"PLACEMENT\"

    \n
    • \n
\n

Acceptable values for \"time_granularity\" include:

\n
    \n

  • \"DAY\"

    \n
    • \n

  • \"WEEK\"

    \n
    • \n

  • \"MONTH\"

    \n
    • \n
\n

Acceptable values for \"metrics\" include:

\n
    \n

  • \"CLICKS\"

    \n
    • \n

  • \"IMPRESSSIONS\"

    \n
    • \n

  • \"CTR\"

    \n
    • \n

  • \"CONVERSIONS\"

    \n
    • \n

  • \"SPEND\"

    \n
    • \n

  • \"CPM\"

    \n
    • \n

  • \"CPC\"

    \n
    • \n

  • \"BILLABLE_SPEND\"

    \n
    • \n
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"73491e00-0844-4c25-bf00-0c3e18d3b6c6","name":"reporting/scheduled/create","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/reporting/scheduled/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"timezone\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"is_archived\": \"\"\n}"}],"_postman_id":"58c084b6-35a5-41c8-90bb-8a76aed5fee3"},{"name":"reporting/scheduled/archive","id":"490f4801-5e0a-46a9-887d-6ce91cf74300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"id\": \"\"\n}","options":{"raw":{"language":"json"}}},"description":"

Archives a scheduled report. Upon a successful request the updated scheduled report object is returned.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"695924d8-3466-422e-a1a6-7c24ccaf6af2","name":"reporting/scheduled/archive","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"advertiser_id\": \"\",\n \"id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/reporting/scheduled/archive"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"advertiser_id\": \"\",\n \"name\": \"\",\n \"schedule\": \"\",\n \"timezone\": \"\",\n \"recipient_emails\": [\"\"],\n \"dimension_granularity\": [\"\"],\n \"time_granularity\": [\"\"],\n \"metrics\": [\"\"],\n \"campaign_ids\": [\"\"],\n \"adgroup_ids\": [\"\"],\n \"ad_ids\": [\"\"],\n \"is_archived\": \"\"\n}"}],"_postman_id":"490f4801-5e0a-46a9-887d-6ce91cf74300"}],"id":"ef7b6ba0-9966-41da-8fc0-640c8a3ccf95","description":"

Generate downloadable CSV reports

\n","_postman_id":"ef7b6ba0-9966-41da-8fc0-640c8a3ccf95"},{"name":"Targeting","item":[{"name":"targeting/geo/state/list","id":"e6ac246a-39a5-499c-8f65-0c3bec638bc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of state level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"c65455c9-385b-4803-b80d-652560869003","name":"targeting/geo/state/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/geo/state/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"state_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"e6ac246a-39a5-499c-8f65-0c3bec638bc7"},{"name":"targeting/geo/city/list","id":"c6939221-2e58-4b0e-84f4-e65f6d13be24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Returns a list of city level targeting values available to be used for adgroup targeting for create/update operations.

\n

Optional request arguments can be passed in for cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"6dbb7c9a-e359-4917-86c4-9ac77724f436","name":"targeting/geo/city/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/targeting/geo/city/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"city_targeting\" : [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"end_cursor\": \"\",\n \"page_size\": \"\"\n }\n}"}],"_postman_id":"c6939221-2e58-4b0e-84f4-e65f6d13be24"},{"name":"targeting/geo/dma/list","id":"ae6774b7-fa1f-40e4-b48c-9116f5befeed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of dma level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"0d18e7ee-55f4-41cf-8c09-8c8254307d2d","name":"targeting/geo/dma/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/geo/dma/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"dma_targeting\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"ae6774b7-fa1f-40e4-b48c-9116f5befeed"},{"name":"targeting/geo/postalcode/list","id":"c016d807-dd46-47f6-98f9-fa920ec33073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

Returns a list of postal code level targeting values available to be used for adgroup targeting for create/update operations.

\n

Optional request arguments can be passed in for page_cursor and page size, which will be used when querying for data and returning pagination data.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"a705eedd-310c-499e-8664-7cb986eeec28","name":"targeting/geo/postalcode/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pagination_parameters\": {\n \"page_size\": \"\",\n \"cursor\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/targeting/geo/postalcode/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"postalcode_targeting\": [\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"cursor\": \"\",\n \"data\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"page_info\": {\n \"page_size\": \"\",\n \"end_cursor\": \"\"\n }\n}"}],"_postman_id":"c016d807-dd46-47f6-98f9-fa920ec33073"},{"name":"targeting/geo/postalcode/bulk_match","id":"5e3cb6cc-0d18-4858-94a5-5b1c652d778f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"postal_codes\": \";,\\n\"\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

Takes a string list of postal code locations, and matches them to their NAM targeting values to be used for adgroup targeting for create/update operations. Also returns which postal codes were unable to be matched.

\n

Allowed separators: , ; \\n

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"a7826238-737a-4844-a83f-09cc4306ce1b","name":"targeting/geo/postalcode/bulk_match","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"postal_codes\": \"01001,01002;01003\\n01001234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ads.nextdoor.com/v2/api/targeting/geo/postalcode/bulk_match"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"matching_postal_code_ids\": [\n \"\",\n \"\",\n \"\"\n ],\n \"invalid_postal_codes\": [\"\"]\n}"}],"_postman_id":"5e3cb6cc-0d18-4858-94a5-5b1c652d778f"},{"name":"targeting/demographics/gender/list","id":"08ebc865-fa72-4bd9-bc54-e038207cff00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of gender level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"5c71b7a3-9263-49cf-86e3-5ae4e46c32a2","name":"targeting/demographics/gender/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/demographics/gender/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"gender_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"08ebc865-fa72-4bd9-bc54-e038207cff00"},{"name":"targeting/demographics/age/list","id":"f4c6f2ed-19e8-4f86-8f87-9d4e937a1f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of age level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"0db3a6a4-577e-4065-b485-97297531d7d9","name":"targeting/demographics/age/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/demographics/age/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"age_targeting\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"f4c6f2ed-19e8-4f86-8f87-9d4e937a1f87"},{"name":"targeting/demographics/homeownership/list","id":"5d96022c-56d4-413b-a09b-3235d55951a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of homeownership level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"ad225708-4179-45de-9203-ae69f80852f3","name":"targeting/demographics/homeownership/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/demographics/homeownership/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"homeowenrship_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"5d96022c-56d4-413b-a09b-3235d55951a1"},{"name":"targeting/demographics/income/list","id":"d94f18a0-f54a-4c19-a6cb-e4754c7a7304","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of income level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"8de4da31-1b63-45c5-9a96-061b60d1e5b4","name":"targeting/demographics/income/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/demographics/income/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"income_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"d94f18a0-f54a-4c19-a6cb-e4754c7a7304"},{"name":"targeting/interest/list","id":"be46588e-f64a-47e0-9fdb-90c87a851d1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of interest level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"eced834d-043b-44a6-bbd2-c1caec20377a","name":"targeting/interest/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/interest/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"interest_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"be46588e-f64a-47e0-9fdb-90c87a851d1a"},{"name":"targeting/device/list","id":"8342f0cc-1480-455a-af3a-fda60abd4b48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Returns a list of device level targeting values available to be used for adgroup targeting for create/update operations.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"000fe100-8fec-430d-bd70-b891cb1adc88","name":"targeting/devices/list","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://ads.nextdoor.com/v2/api/targeting/device/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"device_targeting\" : [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}"}],"_postman_id":"8342f0cc-1480-455a-af3a-fda60abd4b48"}],"id":"bfc040e5-357f-4927-91a2-37a5604f753a","_postman_id":"bfc040e5-357f-4927-91a2-37a5604f753a","description":""}]}