Skip to main content
PATCH
/
api
/
public
/
minha-area
/
profile
Atualizar E-mail de Cobrança
curl --request PATCH \
  --url https://garu.com.br/api/public/minha-area/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sellerId": 123,
  "billingEmailOverride": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.garu.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Visão Geral

Endpoint autenticado pelo link mágico. Permite ao cliente definir um e-mail específico (billingEmailOverride) para receber cobranças de um vendedor específico — útil quando o cliente prefere que cobranças cheguem em um endereço fixo (ex: cobrancas@empresa.com.br) diferente do e-mail pessoal. O override é fixo: mesmo que o cliente troque o e-mail principal em uma cobrança futura, o desta loja não muda. Para voltar ao padrão, envie billingEmailOverride: null.

Resolução do e-mail enviado

billingEmailOverride (definido aqui)
  ?? CustomerSellerProfile.lastUsedEmail (último visto neste vendedor)
  ?? Customer.email (e-mail principal global)

Autenticação

Header Authorization: Bearer <jwt-do-link-mágico>.

Exemplo de Requisição

# Definir um e-mail fixo para o vendedor 10
curl -X PATCH https://garu.com.br/api/public/minha-area/profile \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI..." \
  -H "Content-Type: application/json" \
  -d '{
    "sellerId": 10,
    "billingEmailOverride": "cobrancas@empresa.com.br"
  }'

# Limpar o override (volta ao padrão)
curl -X PATCH https://garu.com.br/api/public/minha-area/profile \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI..." \
  -H "Content-Type: application/json" \
  -d '{
    "sellerId": 10,
    "billingEmailOverride": null
  }'

Parâmetros

sellerId
number
required
ID do vendedor para o qual aplicar o e-mail. Deve ser um vendedor com o qual o cliente já tem relacionamento (uma cobrança ou pagamento existente).
billingEmailOverride
string | null
required
E-mail a fixar como override. Envie null (literal) para limpar o override e voltar ao e-mail padrão do cliente.

Resposta

{ "success": true }

Erros

  • 400 Bad RequestbillingEmailOverride não é um e-mail válido (e não é null).
  • 401 Unauthorized — JWT expirado/inválido.
  • 403 Forbidden — cliente não tem relacionamento com o sellerId informado.
  • 404 Not Found — cliente associado ao token não existe mais (caso raro de exclusão).