Pular para o conteúdo principal
POST
Criar campanha

Corpo

application/json

Dados de criação

name
string | null

Nome da campanha

Exemplo:

"Dia das mães"

description
string | null

Descrição da campanha

Exemplo:

"Campanha em comemoração ao dia das mães"

type
enum<string> | null
padrão:advanced

Tipo da campanha

Opções disponíveis:
advanced,
cartItem
Exemplo:

"advanced"

state
enum<string> | null
padrão:draft

Estado da campanha

Opções disponíveis:
draft,
enabled,
disabled,
archived
Exemplo:

"enabled"

startAt
string<date-time>

Data de início da vigência da campanha.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2024-06-05T09:00:00-03:00"

endAt
string<date-time> | null

Data de término da vigência da campanha.

É esperada uma string de timestamp no formato RFC3339.

Exemplo:

"2030-06-05T23:59:59-03:00"

features
enum<string>[] | null

Lista de recursos da campanha

Opções disponíveis:
coupons,
referrals,
loyalty,
giveaways
Exemplo:
tags
string[] | null

Lista de tags da campanha

Exemplo:
attributes
object | null

Atributos customizados de chave e valor

Exemplo:

Resposta

Created

data
object

Identificador genérico