AdGroup

Create an ad group based on the inputs passed in

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

Request

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

Path parameters

advertiserIdstring required

The id of the advertiser for which the request is made

Request body

campaign_idstring

The campaign id to create an ad group for

conversion_optimization_goal'ALL_CONVERSIONS' | 'PURCHASE' | 'LEAD' nullable

The conversion optimization goal for this ad group

end_timestring date-time nullable

The end time for this ad group

namestring

The ad group name

placementsstring[]

The placements configured for this ad group

start_timestring date-time

The start time for this ad group

user_status'ACTIVE' | 'DRAFT' nullable

The user status to create this ad group as draft if needed

Response

The newly created ad group

advertiser_idstring

The advertiser id that this ad group is tied to

campaign_idstring

The campaign id that this ad group is tied to

created_atstring date-time

The creation time of the ad group

end_timestring date-time nullable

The end time for this ad group

idstring

The id of the ad group

namestring

The name of the ad group

placementsstring[]

The placements configured for this ad group

start_timestring date-time

The start time for this ad group

status'DRAFT' | 'ACTIVE' | 'PARTIALLY_ACTIVE' | 'NO_ADS' | 'ARCHIVED' | 'PAUSED' | 'PAUSED_DUE_TO_CAMPAIGN_PAUSE' | 'COMPLETED' | 'PENDING' | 'INELIGIBLE'

The delivery status of the ad group

updated_atstring date-time

The last updated time of the ad group

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

The user set status of the ad group

Changes

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