NEnextdoor
AdGroup

Updates an ad group user status

put/api/v3/advertisers/{advertiserId}/adgroups/{adgroupId}/status

Request

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

Path parameters

adgroupIdstring required

The ad group id for which to fetch the info

advertiserIdstring required

The id of advertiser for which ad group will be returned

Request body

user_status'ACTIVE' | 'PAUSED'

The user status to set for the ad group

Response

The updated 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.