Console API

Ads accounts

4 endpoints.

GET/api/v1/admin/businesses/{business_id}/ads/accounts

List ad accounts for the business

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`external_platform`	query	`string \| null`
`include_revoked`	query	`boolean`	default false
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_AdAccountData__

Field Type Description

request_idrequired string

success true default true

datarequired

AdAccountData[]

AdAccountData[] fields

Field	Type	Description
`id`required	`string (uuid)`
`businessId`required	`string (uuid)`
`externalPlatform`required	`string`
`externalPlatformAccountId`required	`string`
`externalPlatformBusinessId`	`string \| null`
`defaultPageId`	`string \| null`
`currencyCode`required	`string`
`timezoneName`required	`string`
`connectedAt`required	`string (date-time)`
`lastValidatedAt`	`string (date-time) \| null`
`revokedAt`	`string (date-time) \| 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.

GET/api/v1/admin/businesses/{business_id}/ads/accounts/{ads_account_id}/pages

List Pages on a connected ad account (live)

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_list_AdPageData__

Field Type Description

request_idrequired string

success true default true

datarequired

AdPageData[]

AdPageData[] fields

Field	Type	Description
`id`required	`string`
`name`required	`string`
`category`	`string \| null`

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/accounts/{ads_account_id}/revoke

Revoke an ad-account link (soft).

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`ads_account_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/discovery/import

Discover ad accounts + pages from provider; upsert ads_accounts

Parameters

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

Request bodyrequired

application/jsonDiscoveryImportBody

Field	Type	Description
`externalPlatform`required	`string`
`oauthConnectionId`	`string (uuid) \| null`

Responses

200Successful Response

application/jsonSuccessResponse_DiscoveryImportData_

Field Type Description

request_idrequired string

success true default true

datarequired

DiscoveryImportData

DiscoveryImportData fields

Field	Type	Description
`accounts`required	`AdAccountData[]`	AdAccountData[] fields AdAccountData (not expanded)
`pages`required	`AdPageData[]`	AdPageData[] fields AdPageData (not expanded)

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.