API atual/Referência completa/WhatsApp: resultados e orçamento

Orçamento mensal

Define quanto a loja aceita gastar por mês com mensagens do WhatsApp e se as campanhas param ao atingir o teto.

O orçamento é um limite mensal de gasto estimado com mensagens da Meta. Existe um por loja, não um por número nem por seller. Com o teto rígido (hard_cap) ligado, quando o gasto do mês alcança o valor, as campanhas em envio voltam para a fila. O orçamento nunca bloqueia respostas da caixa de entrada nem do assistente: só o disparo de campanhas.

Ler o orçamento

GET/api/v1/admin/whatsapp-confluence/budgetAdmin

Retorna o orçamento e o gasto do mês

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/budget" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Orçamento

json

{
  "budget": {
    "monthly_budget_cents": 50000,
    "alert_thresholds": [
      50,
      80,
      100
    ],
    "hard_cap": true
  },
  "spent_cents": 4200
}

200Loja sem orçamento definido

json

{
  "budget": {
    "alert_thresholds": [
      50,
      80,
      100
    ],
    "hard_cap": false
  },
  "spent_cents": 0
}

Campos da resposta

budgetobject

O orçamento salvo. Se nada foi salvo, vem o padrão abaixo.

monthly_budget_centsinteger

Limite mensal em centavos (50000 = R$ 500,00). Omitido quando não há limite.

alert_thresholdsarray

Percentuais do orçamento marcados para alerta. Padrão [50, 80, 100]. Pode vir null, veja o aviso na gravação.

hard_capboolean

true pausa as campanhas ao atingir o limite. Padrão false.

spent_centsinteger

Gasto estimado do mês corrente, em centavos, somando o custo diário registrado (mesma base de Custos).

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`

Gravar o orçamento

A gravação substitui o orçamento inteiro. Para manter um limite, envie monthly_budget_cents de novo: omitido (ou null), o limite é removido. A resposta não devolve o orçamento; leia-o de novo com o GET.

PUT/api/v1/admin/whatsapp-confluence/budgetAdmin

Define o orçamento mensal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

monthly_budget_centsinteger

Limite mensal em centavos. Omitido ou null remove o limite. Não há validação: valores negativos são aceitos.

alert_thresholdsarray

Percentuais para alerta, por exemplo [50, 80, 100]. Envie sempre: omitido, é gravado null.

hard_capboolean

Pausar campanhas ao atingir o limite. Omitido vale false.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/budget" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "monthly_budget_cents": 50000,
  "alert_thresholds": [
    50,
    80,
    100
  ],
  "hard_cap": true
}'

Resposta

200Orçamento gravado

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok. A rota não devolve o orçamento; leia-o de novo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
400	Corpo que não é JSON, ou `monthly_budget_cents` que não é inteiro.	`{"error":"invalid body"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`

Veja também

API atual/Referência completa/WhatsApp: resultados e orçamento

Orçamento mensal

Define quanto a loja aceita gastar por mês com mensagens do WhatsApp e se as campanhas param ao atingir o teto.

Ler o orçamento

GET/api/v1/admin/whatsapp-confluence/budgetAdmin

Retorna o orçamento e o gasto do mês

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/budget" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Orçamento

json

{
  "budget": {
    "monthly_budget_cents": 50000,
    "alert_thresholds": [
      50,
      80,
      100
    ],
    "hard_cap": true
  },
  "spent_cents": 4200
}

200Loja sem orçamento definido

json

{
  "budget": {
    "alert_thresholds": [
      50,
      80,
      100
    ],
    "hard_cap": false
  },
  "spent_cents": 0
}

Campos da resposta

budgetobject

O orçamento salvo. Se nada foi salvo, vem o padrão abaixo.

monthly_budget_centsinteger

Limite mensal em centavos (50000 = R$ 500,00). Omitido quando não há limite.

alert_thresholdsarray

Percentuais do orçamento marcados para alerta. Padrão [50, 80, 100]. Pode vir null, veja o aviso na gravação.

hard_capboolean

true pausa as campanhas ao atingir o limite. Padrão false.

spent_centsinteger

Gasto estimado do mês corrente, em centavos, somando o custo diário registrado (mesma base de Custos).

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`

Gravar o orçamento

PUT/api/v1/admin/whatsapp-confluence/budgetAdmin

Define o orçamento mensal

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador da loja. Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

monthly_budget_centsinteger

Limite mensal em centavos. Omitido ou null remove o limite. Não há validação: valores negativos são aceitos.

alert_thresholdsarray

Percentuais para alerta, por exemplo [50, 80, 100]. Envie sempre: omitido, é gravado null.

hard_capboolean

Pausar campanhas ao atingir o limite. Omitido vale false.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/budget" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "monthly_budget_cents": 50000,
  "alert_thresholds": [
    50,
    80,
    100
  ],
  "hard_cap": true
}'

Resposta

200Orçamento gravado

json

{
  "status": "ok"
}

Campos da resposta

statusstring

Sempre ok. A rota não devolve o orçamento; leia-o de novo.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
400	Corpo que não é JSON, ou `monthly_budget_cents` que não é inteiro.	`{"error":"invalid body"}`
500	Falha interna ao ler ou gravar.	`{"error":"..."}`