API atual/Referência completa/WhatsApp: configuração

Termo de consentimento

Define o aviso de privacidade (LGPD) que acompanha a primeira mensagem enviada a cada telefone.

Pela LGPD, quem recebe mensagens da loja precisa saber para quê e como parar. O termo de consentimento é um texto curto com o link da política de privacidade. Quando está ligado, a plataforma o anexa à primeira mensagem que a loja envia a cada telefone, qualquer que seja ela (boas-vindas, resposta do assistente, código de acesso, aviso de pedido, resposta de atendente), e nunca mais volta a incluí-lo para aquele telefone.

Ler o termo

GET/api/v1/vendor/whatsapp-confluence/consent-termSeller

Retorna o termo e o que o editor precisa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/consent-term" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Termo

json

{
  "config": {
    "enabled": true,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "defaults": {
    "enabled": false,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "store_name": "Loja Exemplo",
  "privacy_url": "https://minhaloja.io.venddor.com.br/wa/privacidade",
  "limits": {
    "text": 600
  }
}

Campos da resposta

configobject

O termo salvo.

enabledboolean

Se o termo é anexado à primeira mensagem de cada telefone. Padrão desligado.

textstring

Texto do termo. Contém {loja} e obrigatoriamente {link_privacidade}.

defaultsobject

Texto e estado de fábrica, para restaurar.

store_namestring

Nome da loja que entra no lugar de {loja}.

privacy_urlstring

Endereço da página de privacidade da mini-loja que entra no lugar de {link_privacidade}.

limitsobject

text: máximo de caracteres (600).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Gravar o termo

Mesmo ao desligar o termo (enabled: false) o texto precisa ser válido: a validação roda sempre. A resposta é a mesma da leitura.

PUT/api/v1/vendor/whatsapp-confluence/consent-termSeller

Valida e grava o termo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

enabledboolean

Liga ou desliga o termo. Omitido vale false: o termo é desligado.

textstringobrigatório

1 a 600 caracteres e precisa conter {link_privacidade}. Pode conter {loja}.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/consent-term" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
}'

Resposta

200Termo salvo

json

{
  "config": {
    "enabled": true,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "defaults": {
    "enabled": false,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "store_name": "Loja Exemplo",
  "privacy_url": "https://minhaloja.io.venddor.com.br/wa/privacidade",
  "limits": {
    "text": 600
  }
}

Campos da resposta

configobject

O termo salvo.

enabledboolean

Se o termo é anexado à primeira mensagem de cada telefone. Padrão desligado.

textstring

Texto do termo. Contém {loja} e obrigatoriamente {link_privacidade}.

defaultsobject

Texto e estado de fábrica, para restaurar.

store_namestring

Nome da loja que entra no lugar de {loja}.

privacy_urlstring

Endereço da página de privacidade da mini-loja que entra no lugar de {link_privacidade}.

limitsobject

text: máximo de caracteres (600).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	Falta o privilégio `vendor_settings` ou `vendor_manage_whatsapp`, ou o WhatsApp da loja não é deste seller.	`{"error":"store_whatsapp_owner_required"}`
400	Texto inválido. `reason`: `required`, `too_long` ou `link_required`.	`{"error":"invalid_consent_term","detail":"text: link_required","field":"text","reason":"link_required"}`
400	Corpo que não é JSON.	`{"error":"invalid body"}`

Veja também

API atual/Referência completa/WhatsApp: configuração

Termo de consentimento

Define o aviso de privacidade (LGPD) que acompanha a primeira mensagem enviada a cada telefone.

Ler o termo

GET/api/v1/vendor/whatsapp-confluence/consent-termSeller

Retorna o termo e o que o editor precisa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/consent-term" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Termo

json

{
  "config": {
    "enabled": true,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "defaults": {
    "enabled": false,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "store_name": "Loja Exemplo",
  "privacy_url": "https://minhaloja.io.venddor.com.br/wa/privacidade",
  "limits": {
    "text": 600
  }
}

Campos da resposta

configobject

O termo salvo.

enabledboolean

Se o termo é anexado à primeira mensagem de cada telefone. Padrão desligado.

textstring

Texto do termo. Contém {loja} e obrigatoriamente {link_privacidade}.

defaultsobject

Texto e estado de fábrica, para restaurar.

store_namestring

Nome da loja que entra no lugar de {loja}.

privacy_urlstring

Endereço da página de privacidade da mini-loja que entra no lugar de {link_privacidade}.

limitsobject

text: máximo de caracteres (600).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Gravar o termo

Mesmo ao desligar o termo (enabled: false) o texto precisa ser válido: a validação roda sempre. A resposta é a mesma da leitura.

PUT/api/v1/vendor/whatsapp-confluence/consent-termSeller

Valida e grava o termo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Corpo da requisição

enabledboolean

Liga ou desliga o termo. Omitido vale false: o termo é desligado.

textstringobrigatório

1 a 600 caracteres e precisa conter {link_privacidade}. Pode conter {loja}.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/whatsapp-confluence/consent-term" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
}'

Resposta

200Termo salvo

json

{
  "config": {
    "enabled": true,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "defaults": {
    "enabled": false,
    "text": "Ao continuar esta conversa, você concorda em receber mensagens da {loja} pelo WhatsApp relacionadas ao seu atendimento, pedidos e produtos, nos termos da nossa Política de Privacidade, disponível em {link_privacidade}. Você pode pedir para parar de receber mensagens a qualquer momento."
  },
  "store_name": "Loja Exemplo",
  "privacy_url": "https://minhaloja.io.venddor.com.br/wa/privacidade",
  "limits": {
    "text": 600
  }
}

Campos da resposta

configobject

O termo salvo.

enabledboolean

Se o termo é anexado à primeira mensagem de cada telefone. Padrão desligado.

textstring

Texto do termo. Contém {loja} e obrigatoriamente {link_privacidade}.

defaultsobject

Texto e estado de fábrica, para restaurar.

store_namestring

Nome da loja que entra no lugar de {loja}.

privacy_urlstring

Endereço da página de privacidade da mini-loja que entra no lugar de {link_privacidade}.

limitsobject

text: máximo de caracteres (600).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	Falta o privilégio `vendor_settings` ou `vendor_manage_whatsapp`, ou o WhatsApp da loja não é deste seller.	`{"error":"store_whatsapp_owner_required"}`
400	Texto inválido. `reason`: `required`, `too_long` ou `link_required`.	`{"error":"invalid_consent_term","detail":"text: link_required","field":"text","reason":"link_required"}`
400	Corpo que não é JSON.	`{"error":"invalid body"}`