Skip to main content
POST
Adicionar pixel de rastreamento

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
productId
string
required

Produto em que o pixel vai disparar, de GET /v1/products. Um pixel nasce sempre ligado a um produto.

Pattern: ^[cC][^\s-]{8,}$
pixelServiceTypeId
integer
required

Provedor do pixel — ver GET /v1/pixel-providers.

Required range: x > 0
pixelCode
string
required

Identificador do pixel na plataforma de anúncios, ou o trecho de código copiado dela.

Required string length: 1 - 4096
checkoutId
string

Liga o pixel também a um checkout v2; aquele checkout passa a disparar só os pixels dele.

Pattern: ^[cC][^\s-]{8,}$
name
string

Apelido para o vendedor reconhecer o pixel.

Required string length: 2 - 255
valueType
enum<string>
default:total_order_and_feess

Qual valor vai na conversão.

Available options:
total_order_and_feess,
total_products_and_freight
isMarkPix
boolean
default:false

Dispara a conversão já na geração do Pix.

status
boolean
default:true

Nasce disparando; envie false para cadastrar pausado.

conversionLabel
string | null

Rótulo de conversão do Google Ads.

conversionValue
integer | null

Valor fixo de conversão em centavos.

triggerOnCheckout
boolean
default:false

Dispara ao abrir o checkout.

triggerOnBeginCheckout
boolean
default:false

Dispara ao começar o preenchimento.

capiAccessToken
string | null

Token da API de conversões do provedor. Guardado cifrado e nunca devolvido na leitura.

testEventCode
string | null

Código de evento de teste do provedor.

Response

Pixel cadastrado.

Pixel cadastrado.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required