Console API

Meta Conversions API

4 endpoints.

GET/api/v1/admin/businesses/{business_id}/integrations/meta/capi

Get Meta CAPI config for a business

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_MetaCapiConfigData_

Field Type Description

request_idrequired string

success true default true

datarequired

MetaCapiConfigData

MetaCapiConfigData fields

Field	Type	Description
`pixel_id`	`string \| null`
`test_event_code`	`string \| null`
`enabled`	`boolean`	default false
`connected`	`boolean`	default false

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.

PUT/api/v1/admin/businesses/{business_id}/integrations/meta/capi

Set Meta CAPI config (pixel id, enable, test event code)

Parameters

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

Request bodyrequired

application/jsonMetaCapiConfigBody

Field	Type	Description
`pixel_id`required	`string`
`test_event_code`	`string \| null`
`enabled`	`boolean`	default false

Responses

200Successful Response

application/jsonSuccessResponse_MetaCapiConfigData_

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

GET/api/v1/admin/businesses/{business_id}/integrations/meta/capi/pixels

Discover Meta pixels on a business' connected ad account

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_MetaCapiPixelsData_

Field Type Description

request_idrequired string

success true default true

datarequired

MetaCapiPixelsData

MetaCapiPixelsData fields

Field	Type	Description
`pixels`required	`MetaPixelData[]`	MetaPixelData[] fields MetaPixelData (not expanded)
`connected`	`boolean`	default true

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}/integrations/meta/capi/test

Fire a test CAPI event (validate sender via Events Manager Test Events)

Parameters

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

Request bodyrequired

application/jsonMetaCapiTestBody

Field	Type	Description
`event_name`	`string`	default "Lead"
`email`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_MetaCapiTestResult_

Field Type Description

request_idrequired string

success true default true

datarequired

MetaCapiTestResult

MetaCapiTestResult fields

Field	Type	Description
`events_received`	`integer`	default 0
`fbtrace_id`	`string \| null`
`messages`	`string[]`	default [] string[] fields

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.