CampaignDetails

audience
Type:
required

Quem recebe a campanha.

Properties: 8
created_at
Type: stringFormat: date-time
required

Quando a campanha foi criada (horário local da loja).
id
Type: integer
required

Id da campanha. Passe-o para /api/campaign/details/.
message
Type: string
required

Texto da mensagem enviada aos clientes.
messages
Type:
required

Contagem das mensagens da campanha por situação.

Properties: 7
purchase_count_days
Type: integer
required

Dias após o envio em que uma compra do cliente é atribuída à campanha.
schedule
Type:
required

Quando as mensagens são enviadas.

Properties: 3
status
Type: string
required

Situação: idle (aguardando início), active, paused, limit_reached, finished ou cancelled.
title
Type: string
required

Título da campanha.
coupon_id
Type: integernullable

Id do cupom enviado junto com a mensagem, quando houver. Consultá-lo em /api/coupon/details/ exige o escopo store.
ends_at
Type: stringFormat: date-timenullable

Quando os envios terminam (horário local da loja).
image_url
Type: stringnullable

URL da imagem enviada junto com a mensagem, quando houver.
starts_at
Type: stringFormat: date-timenullable

Quando os envios começam (horário local da loja).