NEnextdoor
Campaign

Create a campaign based on the inputs passed in

post/api/v3/advertisers/{advertiserId}/campaigns

Request

  • Base URL
    https://ads.nextdoor.com
  • URL
    https://ads.nextdoor.com/api/v3/advertisers/{advertiserId}/campaigns
  • Auth
    HTTP bearer

Path parameters

advertiserIdstring required

The id of the advertiser for which the request is made

Request body

namestring

The new campaign's name

objective'AWARENESS' | 'CONSIDERATION' | 'CONVERSION' | 'LEAD_GENERATION'

The new campaign's objective

sub_objective'BRAND_AWARENESS' | 'WEBSITE_VISITS' | 'LEAD_GENERATION' | 'WEBSITE_CONVERSIONS' | 'APP_INSTALL' nullable

The new campaign's sub-objective

Response

The newly created campaign

advertiser_idstring

The advertiser id this campaign is tied to.

created_atstring date-time

The creation time of the campaign.

end_timestring date-time nullable

The end time of the campaign based on its last running ad group, null if there are no ad groups or if there are ad groups running indefinitely.

idstring

The id of the campaign.

namestring

The name of the campaign.

objective'AWARENESS' | 'CONSIDERATION' | 'CONVERSION' | 'LEAD_GENERATION'

The objective of the campaign.

start_timestring date-time nullable

The start time of the campaign based on the earliest running ad group, null if there are no ad groups.

status'DRAFT' | 'ACTIVE' | 'NO_ACTIVE_AD_GROUPS' | 'PAUSED' | 'ARCHIVED' | 'PAUSED_FOR_BILLING' | 'INELIGIBLE'

The status of the campaign computed based on the user status and internal checks.

sub_objective'BRAND_AWARENESS' | 'WEBSITE_VISITS' | 'LEAD_GENERATION' | 'WEBSITE_CONVERSIONS' | 'APP_INSTALL' nullable

The sub-objective of the campaign.

updated_atstring date-time

The last update time of the campaign.

user_status'ACTIVE' | 'PAUSED' | 'ARCHIVED'

The user set status of the campaign.

Changes

No recorded changes to this operation across all 1 revision of this API.