Docs
EntrarCriar conta
Ambiente
Base URLhttps://api.sancopay.com/api/v1
Arquivo para IA
RecorrênciaRequer liberação

E-mails

Personalize o e-mail que o cliente recebe (vencimento e lembrete) e a página de pagamento: nome da loja, textos, cores e logotipo.

  • GET/recurring/email-settingsPersonalização salva, os textos padrão, as variáveis e a marca em uso.
  • PUT/recurring/email-settingsSalva nome da loja, assunto, título e mensagem (vencimento e lembrete) e as cores.
  • POST/recurring/email-settings/previewMesmo corpo do PUT + kind (due ou reminder); devolve subject, sender_name e html sem salvar.
  • POST/recurring/email-settings/logoTroca o logotipo: multipart/form-data com o campo logo (PNG, JPG ou WEBP, até 2 MB, 32 a 4000 px por lado).
  • DEL/recurring/email-settings/logoRemove o logotipo.
PUT/recurring/email-settings

Alteração parcial: campos não enviados ficam como estão.

Corpo da requisição (tudo opcional)

CampoTipoDescrição
display_nameopcionalstringNome da loja (até 120, uma linha): remetente, {{company_name}} e página de pagamento.
due_subjectopcionalstringAssunto do e-mail do vencimento (até 200, uma linha).
due_headingopcionalstringTítulo do e-mail do vencimento (até 150, uma linha).
due_messageopcionalstringMensagem de abertura do vencimento (até 1000; mantém as quebras de linha).
reminder_subjectopcionalstringAssunto do lembrete de atraso.
reminder_headingopcionalstringTítulo do lembrete de atraso.
reminder_messageopcionalstringMensagem de abertura do lembrete.
button_coloropcionalstringCor do botão Pagar com Pix (#RRGGBB; padrão #5030E5).
button_text_coloropcionalstringCor do texto do botão (#RRGGBB).
heading_coloropcionalstringCor do título (#RRGGBB).
Requisição
curl -X PUT "https://api.sancopay.com/api/recurring/email-settings" \  -H "Authorization: Bearer <TOKEN>" \  -H "Content-Type: application/json" \  -d '{    "display_name": "Studio Bem-Estar",    "due_subject": "Sua mensalidade de {{amount}} vence em {{due_date}}",    "due_heading": "Olá, {{customer_name}}! Hora de renovar",    "button_color": "#1A73E8",    "button_text_color": "#FFFFFF"  }'
Resposta200 OK
{  "settings": {    "display_name": "Studio Bem-Estar",    "due_subject": "Sua mensalidade de {{amount}} vence em {{due_date}}",    "due_heading": "Olá, {{customer_name}}! Hora de renovar",    "button_color": "#1A73E8",    "button_text_color": "#FFFFFF",    "due_message": null,    "reminder_subject": null,    "reminder_heading": null,    "reminder_message": null,    "heading_color": null  },  "defaults": {    "display_name": "Minha Loja Ltda",    "due": {      "subject": "Sua cobrança de {{amount}} vence hoje — {{company_name}}",      "heading": "Sua cobrança vence hoje",      "message": "Olá, {{customer_name}}. Chegou o dia do pagamento da sua assinatura com {{company_name}}."    },    "reminder": {      "subject": "Lembrete: cobrança de {{amount}} em atraso — {{company_name}}",      "heading": "Sua cobrança está em atraso",      "message": "Olá, {{customer_name}}. A cobrança abaixo venceu em {{due_date}} e ainda não identificamos o pagamento."    },    "button_color": "#5030E5",    "button_text_color": "#FFFFFF",    "heading_color": "#15112E"  },  "placeholders": {    "customer_name": "Primeiro nome do cliente",    "company_name": "Nome da loja",    "plan_name": "Nome do plano",    "description": "Mensagem da cobrança",    "amount": "Valor (ex.: R$ 99,90)",    "due_date": "Vencimento (dd/mm/aaaa)",    "cycle": "Ciclo (ex.: 3 de 12)"  },  "branding": {    "company_name": "Studio Bem-Estar",    "logo_url": "https://api.sancopay.com/api/public/recurring/logo/Qm3vX9kT2pL7wR4nB8cY1aF5sH0eU6gJ?v=1758207730",    "logo_source": "recurring"  },  "updated_at": "2026-09-18T14:02:10.000000Z"}

Regras

  1. Campo vazio ou null volta ao texto ou à cor padrão (veja defaults).
  2. Variáveis nos textos: {{customer_name}}, {{company_name}}, {{plan_name}}, {{description}} (a mensagem da cobrança), {{amount}}, {{due_date}} e {{cycle}}. Variável desconhecida é removida.
  3. Os textos são texto puro: HTML aparece literal. O display_name muda só o nome do remetente; o endereço continua o da plataforma.
  4. Nome, cores e logotipo valem também na página de pagamento (pay_url). Logotipo: o enviado aqui (logo_source: "recurring") ou, sem ele, o da Recuperação de Vendas (sales_recovery); null = marca da plataforma. A imagem é regravada como PNG; SVG é recusado.
  5. Os e-mails due saem no vencimento (e na criação, com issue_first_charge); os reminder, em D+1 e D+3.