Console API

Ads refresh recommendations

4 endpoints.

GET/api/v1/admin/businesses/{business_id}/ads/campaigns/{campaign_id}/refresh-recommendations

List Refresh Recommendations

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_dict__

Field Type Description

request_idrequired string

success true default true

datarequired

object[]

object[] fields

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.

POST/api/v1/admin/businesses/{business_id}/ads/refresh-recommendations/{recommendation_id}/accept

Accept Refresh Recommendation

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`recommendation_id`required	path	`string (uuid)`
`Idempotency-Key`required	header	`string`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`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/refresh-recommendations/{recommendation_id}/dismiss

Dismiss Refresh Recommendation

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`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/refresh-recommendations/{recommendation_id}/replace-draft-media

Replace Refresh Draft Media

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`recommendation_id`required	path	`string (uuid)`
`Idempotency-Key`required	header	`string`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonReplaceDraftMediaBody

Field	Type	Description
`photo_ids`required	`string (uuid)[]`	min items 1 string (uuid)[] fields

Responses

200Successful Response

application/jsonSuccessResponse_dict_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`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.