Console API

Ads sets

7 endpoints.

GET/api/v1/admin/businesses/{business_id}/ads/ad-sets/{ad_set_id}

Get an ad set

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`ad_set_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AdSetData_

Field Type Description

request_idrequired string

success true default true

datarequired

AdSetData

AdSetData fields

Field	Type	Description
`id`required	`string (uuid)`
`name`required	`string`
`facebookPage`	`string`	default ""
`facebookPageId`	`string \| null`
`destination`	`enum`	one of "website", "facebook-native", "instant_form" · default "website"
`websiteUrl`	`string`	default ""
`dailyBudget`	`string`	default ""
`dailyBudgetMinor`	`integer \| null`
`location`	`string`	default ""
`radius`	`string`	default ""
`radiusMeters`	`integer \| null`
`units`	`AdUnitData[]`	AdUnitData[] fields AdUnitData (not expanded)
`currencyCode`	`string`	default "USD"
`isDraft`	`boolean`	default false
`externalPlatformAdsetId`	`string \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PATCH/api/v1/admin/businesses/{business_id}/ads/ad-sets/{ad_set_id}

Patch ad set fields (mutable; audit-logged)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`ad_set_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAdSetPatchBody

Field	Type	Description
`name`	`string \| null`
`facebookPageId`	`string \| null`
`destination`	`enum \| null`
`destinationUrl`	`string \| null`
`dailyBudgetMinor`	`integer \| null`
`addressLine`	`string \| null`
`lat`	`number \| null`
`lng`	`number \| null`
`radiusMeters`	`integer \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AdSetData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdSetData`	AdSetData fields AdSetData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/businesses/{business_id}/ads/ad-sets/{ad_set_id}

Soft-delete ad set

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`ad_set_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

204Successful Response

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/ads/ad-sets/{ad_set_id}/generate-ad-copy

DEPRECATED: LLM-generate ad copy (use the unit-level generate-copy)

DEPRECATED (KS-2013): copy is per-ad. Delegates to the set's FIRST unit; 409 ``AD_SET_HAS_NO_UNITS`` when the set has none. Use ``POST /businesses/{b}/ads/units/{unit_id}/generate-copy`` instead.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`ad_set_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AdCopyGenerationData_

Field Type Description

request_idrequired string

success true default true

datarequired

AdCopyGenerationData

AdCopyGenerationData fields

Field	Type	Description
`adCopy`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/ads/campaigns/{campaign_id}/ad-sets

List ad sets in a campaign

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`campaign_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AdSetData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdSetData[]`	AdSetData[] fields AdSetData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/ads/campaigns/{campaign_id}/ad-sets

Create an ad set

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`campaign_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAdSetCreateBody

Field	Type	Description
`name`	`string \| null`
`facebookPageId`	`string \| null`
`destination`	`enum`	one of "website", "facebook-native", "instant_form" · default "website"
`destinationUrl`	`string \| null`
`dailyBudgetMinor`	`integer \| null`
`addressLine`	`string \| null`
`lat`	`number \| null`
`lng`	`number \| null`
`radiusMeters`	`integer \| null`
`currencyCode`	`string`	default "USD"

Responses

200Successful Response

application/jsonSuccessResponse_AdSetData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdSetData`	AdSetData fields AdSetData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/ads/generate-ad-copy

LLM-generate ad copy from wizard local state (no persistence)

Pre-draft variant of ``generate-ad-copy``. Used by the New Campaign wizard before any ad set row exists — same generation logic, same business-profile grounding, just sourced from the request body instead of a DB read. No row writes.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonAdCopyPreDraftBody

Field	Type	Description
`destination`	`enum \| null`
`destinationUrl`	`string \| null`
`addressLine`	`string \| null`
`lat`	`number \| null`
`lng`	`number \| null`
`radiusMeters`	`integer \| null`
`dailyBudgetMinor`	`integer \| null`
`currencyCode`	`string \| null`
`campaignName`	`string \| null`
`userPrompt`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_AdCopyGenerationData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`AdCopyGenerationData`	AdCopyGenerationData fields AdCopyGenerationData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.