Inscrever assinante
Inscreve um e-mail na newsletter; repetir o e-mail reativa a inscrição.
Inscreve um e-mail na newsletter da loja. Se o e-mail já existe, a rota não cria outro: devolve o mesmo subscriber_id, atualiza o nome (só se você mandou um) e reativa a inscrição, inclusive a de quem tinha cancelado.
A situação inicial depende da loja: A (ativo) quando a confirmação em duas etapas está desligada, ou P (pendente) quando está ligada, caso em que a pessoa recebe um e-mail de confirmação.
/api/v1.0/subscribersAdminInscrever um e-mail
Corpo da requisição
emailstringobrigatórionamestring/api/subscribersAdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de POST /api/v1.0/subscribers. Use este caminho se o seu cliente já foi escrito para ele. Nesta forma sem versão o subscriber_id sai como número decimal em string, mas o caminho /{id} só aceita o UUID.
Exemplo de requisição
curl -X POST "$BASE_URL/api/v1.0/subscribers" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "maria.souza@example.com",
"name": "Maria Souza"
}'Resposta
{ "subscriber_id": "43053e7f-c17b-4c8a-8009-649f1c0cef85" }Campos da resposta
subscriber_idstring/api/v1.0; decimal em /api). Em uma reinscrição é o id do registro existente.Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Sem credencial. | {"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."} |
| 401 | E-mail ou chave de API inválidos. | {"status":401,"message":"Invalid credentials"} |
| 403 | A credencial é válida, mas o usuário não é administrador. | {"status":403,"message":"Forbidden: admin scope required"} |
| 400 | Corpo que não é JSON. | {"status":400,"message":"Invalid JSON body"} |
| 400 | Sem email (ou vazio). | {"status":400,"message":"email is required"} |