Atualização de Preferências do Cliente
PUT
/customers/{customerId}/flag
Endpoint responsável por atualizar as preferências/flags de comunicação do cliente
Descrição
Este endpoint permite aos usuários administrativos atualizar as preferências de comunicação (flags) de um cliente específico.
As flags controlam como o cliente recebe notificações e comunicações da loja.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação do usuário |
Content-Type | application/json | Tipo do conteúdo |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| customerId | integer | Sim | ID do cliente |
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| sendPromotionalEmail | boolean | Não | Receber promoções por e-mail |
| sendPromotionalSms | boolean | Não | Receber promoções por SMS |
| sendOrderEmail | boolean | Não | Receber notificações de pedidos por e-mail |
| sendOrderSms | boolean | Não | Receber notificações de pedidos por SMS |
Exemplo de Requisição
1curl --request PUT \2 --url 'https://sua-loja-uappi.com.br/api/v3/customers/123/flag' \3 --header 'Authorization: Bearer SEU_TOKEN_AQUI' \4 --header 'Content-Type: application/json' \5 --data '{6 "sendPromotionalEmail": true,7 "sendPromotionalSms": false,8 "sendOrderEmail": true,9 "sendOrderSms": false10 }'✅ Resposta de Sucesso
HTTP Status: 200 OK
1{2 "status": true,3 "data": {4 "sendPromotionalEmail": true,5 "sendPromotionalSms": false,6 "sendOrderEmail": true,7 "sendOrderSms": false8 }9}Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| sendPromotionalEmail | boolean | Receber promoções por e-mail |
| sendPromotionalSms | boolean | Receber promoções por SMS |
| sendOrderEmail | boolean | Receber notificações de pedidos por e-mail |
| sendOrderSms | boolean | Receber notificações de pedidos por SMS |
⚠️ Possíveis Erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código HTTP | Descrição |
|---|---|---|
| UAPPI_STORE_CUSTOMER_NOT_FOUND | 404 | Cliente não foi encontrado |
| UAPPI_STORE_INVALID_CUSTOMER_FLAG | 404 | A flag solicitada não foi encontrada |