ad-groups

Update an ad group

Partial update. Send only the fields you want to change; omitted fields keep their values, and a field you do send replaces the stored value in full (arrays included). Changes reach the ad platforms on the next sync.

Errors

  • 404 NOT_FOUND: no ad group with this id in the active Space.
  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
put/api/v1/ad-groups/{id}

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/ad-groups/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ad group id.

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

_nativeNativeExtensions

Settings that exist on one platform only, keyed by platform id (for example google-ads). Each value is a free-form object that is stored and returned exactly as sent; keys Growomat does not know are kept. Absent by default.

Keys read by platforms whose ad is a post (on the ad, with the campaign as fallback): postType (TEXT or IMAGE), postTitle, postBody, callToAction, imageUrl, videoUrl, videoThumbnailUrl, carouselCards ([{ imageUrl, destinationUrl }]), communities, interests.

Delivery keys read on the campaign: objective, goalType, startTime, endTime, optimizationGoal, conversionPixelId.

campaignIdstring

The campaign this ad group belongs to.

namestring

Ad group name.

status'ENABLED' | 'PAUSED' | 'REMOVED'

A paused ad group serves nothing, whatever its ads say.

typestring

The platform's ad group type. Leave the default unless the platform requires otherwise.

cpcnumber
cpcBidnumber

Default maximum cost per click for the ad group's keywords, in the campaign currency.

customLabelsstring[]

Free-form labels for your own grouping and reporting.

trackingUrlTemplatestring

Tracking template for this ad group; overrides the campaign's.

finalUrlSuffixstring

Query string appended to final URLs; overrides the campaign's.

urlCustomParametersobject

Custom {_name} parameters available to tracking templates.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

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