Módulo 0627 endpoints

Users `/users`

Endpoints marcados como Reseller exigem papel de reseller ou superior.

Endpoints

27 no total

GET/users/meUsuário

Dados do usuário autenticado

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "id": 1234, "uname": "usuario", "email": "[email protected]",
  "nombre": "João", "apellido": "Silva", "empresa": "Minha Empresa",
  "role": "user", "user_type": "pro", "parent_id": 100,
  "active": 1, "max_sends": 50000, "max_suscribers": 10000,
  "creditos": 45000, "reputation": 95, "lang": "pt"
}

PUT/users/meUsuário

Atualizar perfil próprio

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`nombre`	`string`	Não	Nome
`apellido`	`string`	Não	Sobrenome
`email`	`string`	Não	Email
`empresa`	`string`	Não	Empresa
`telefono`	`string`	Não	Telefone
`lang`	`string`	Não	"es" ou "en"
`timezone`	`string`	Não	Timezone (e.g. "America/Buenos_Aires")

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "nombre": "...",
  "apellido": "...",
  "email": "...",
  "empresa": "...",
  "telefono": "...",
  "lang": "...",
  "timezone": "..."
}'

Resposta 200

{ "success": true }

PUT/users/me/passwordUsuário

Alterar senha

Invalida todas as sessões ativas em todos os dispositivos.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`currentPassword`	`string`	Sim	Senha atual
`newPassword`	`string`	Sim	Nova senha

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me/password" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "currentPassword": "...",
  "newPassword": "..."
}'

Resposta 200

{ "success": true }

GET/users/me/aicreditsUsuário

Créditos de IA disponíveis

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/aicredits" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "canGenerate": true,
  "monthlyAvailable": 45, "dailyAvailable": 8,
  "maxMonthlyGenerations": 50, "maxDailyGenerations": 10,
  "monthlyUsed": 5, "dailyUsed": 2
}

GET/users/me/public-configUsuário

Configuração pública global para a UI

Expõe valores seguros para o frontend combinando config.json e om_config. Inclui rate limits de eventos e limites de envios de teste.

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/public-config" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "eventRateLimits": {
    "user": { "minute": 60, "hour": 1000, "day": 10000 },
    "global": { "minute": 600, "hour": 10000, "day": 100000 }
  },
  "testSendLimits": {
    "hourly": 10,
    "daily": 50
  }
}

GET/users/me/brand-kitsUsuário

Listar Kits de marca próprios

Retorna apenas os Kits de marca do usuário autenticado.

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/brand-kits" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "list": [
    { "id": 7, "status": "active", "isDefault": true, "revision": 2, "brandName": "Acme" }
  ]
}

POST/users/me/brand-kits/analyze-urlUsuário

Analisar URL para Kit de marca

Somente HTTPS. Bloqueia URLs encurtadas, privadas, internas e redirects cross-host.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`url`	`string`	Sim	URL HTTPS do site a analisar

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/brand-kits/analyze-url" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "..."
}'

Resposta 200

{
  "draft": { "brandName": "Acme", "primaryColor": "#112233", "toneOfVoice": "Directo" },
  "creditCost": 3,
  "poolBalanceAfter": 100
}

Erros

Status	Code	Descrição
400	`url_https_required`	A URL deve usar HTTPS
400	`url_shortener_not_allowed`	Host na blacklist de encurtadores
400	`url_private_host_not_allowed`	Host privado ou interno
400	`url_private_ip_not_allowed`	IP privado, link-local ou reservado
400	`url_cross_host_redirect_not_allowed`	Redirecionamento para outro host
402	`insufficient_credits`	Créditos de IA insuficientes
429	`daily_limit_reached`	Limite diário de IA atingido
429	`monthly_limit_reached`	Limite mensal de IA atingido
429	`rate_limit_exceeded`	Muitas análises seguidas
500	`internal_error`	Erro interno não público

POST/users/me/brand-kits/analyze-campaignsUsuário

Analisar campanhas anteriores para Kit de marca

Analisa até 5 campanhas próprias.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`campaignIds`	`number[]`	Sim	IDs de campanhas próprias. Máximo 5.

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/brand-kits/analyze-campaigns" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignIds": [0]
}'

Resposta 200

{ "draft": { "brandName": "Acme", "ctaStyle": "Directo" } }

Erros

Status	Code	Descrição
400	`missing_campaigns`	Lista vazia ou inválida
400	`too_many_campaigns`	Mais de 5 campanhas
404	`campaign_not_found`	Campanha inexistente ou não pertence ao usuário
402	`insufficient_credits`	Créditos de IA insuficientes
429	`daily_limit_reached`	Limite diário de IA atingido
429	`monthly_limit_reached`	Limite mensal de IA atingido
429	`rate_limit_exceeded`	Muitas análises seguidas
500	`internal_error`	Erro interno não público

POST/users/me/brand-kitsUsuário

Criar Kit de marca

Cria um rascunho editável.

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`name`	`string`	Não	Nome interno do kit
`brandName`	`string`	Não	Nome da marca
`primaryColor`	`string`	Não	Cor hexadecimal #RRGGBB
`toneOfVoice`	`string`	Não	Tom de voz

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/brand-kits" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "brandName": "...",
  "primaryColor": "...",
  "toneOfVoice": "..."
}'

Resposta 201

{ "kit": { "id": 7, "status": "draft", "revision": 1 } }

Erros

Status	Code	Descrição
400	`invalid_brand_kit_color`	Cor inválida
400	`invalid_text_density`	Densidade de texto inválida
500	`brand_kit_create_failed`	Não foi possível criar o registro
500	`internal_error`	Erro interno não público
503	`brand_kits_not_configured`	Falta aplicar a migração do banco de dados

PATCH/users/me/brand-kits/:idUsuário

Atualizar Kit de marca

Permite atualizar apenas kits próprios. Incrementa revision.

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do kit

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`brandName`	`string`	Não	Nome da marca
`visualStyle`	`string`	Não	Estilo visual

Exemplo

curl -X PATCH "https://envios.arrobamail.com/v3/api/users/me/brand-kits/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "brandName": "...",
  "visualStyle": "..."
}'

Resposta 200

{ "kit": { "id": 7, "revision": 2 } }

Erros

Status	Code	Descrição
400	`invalid_brand_kit_color`	Cor inválida
400	`invalid_text_density`	Densidade de texto inválida
404	`brand_kit_not_found`	Não existe ou não pertence ao usuário
500	`internal_error`	Erro interno não público
503	`brand_kits_not_configured`	Falta aplicar a migração do banco de dados

POST/users/me/brand-kits/:id/activateUsuário

Ativar Kit de marca

Marca o kit como ativo/padrão para futuras gerações de IA.

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do kit

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/brand-kits/{ID}/activate" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{ "kit": { "id": 7, "status": "active", "isDefault": true } }

Erros

Status	Code	Descrição
404	`brand_kit_not_found`	Não existe ou não pertence ao usuário
500	`internal_error`	Erro interno não público
503	`brand_kits_not_configured`	Falta aplicar a migração do banco de dados

GET/users/:idReseller

Dados de um usuário específico

Parâmetros de rota

Nome	Descrição
`id`	ID numérico do usuário

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/{ID}" \
  -H "Authorization: Bearer $TOKEN"

GET/users/:id/listReseller

Listar subusuários

Parâmetros de rota

Nome	Descrição
`id`	ID do reseller pai

Query params

Nome	Tipo	Obrig.	Default	Descrição
`offset`	`number`	Não	`0`	Deslocamento
`limit`	`number`	Não	`25`	Itens por página
`userType`	`string`	Não	`-`	Filtro por tipo de usuário
`searchString`	`string`	Não	`-`	Busca por email/username
`sortBy`	`string`	Não	`-`	Campo de ordenação
`sortDesc`	`boolean`	Não	`false`	Ordem decrescente

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/{ID}/list" \
  -H "Authorization: Bearer $TOKEN"

POST/users/:idReseller

Criar subusuário

Parâmetros de rota

Nome	Descrição
`id`	ID do reseller pai

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`uname`	`string`	Sim	Username
`pass`	`string`	Sim	Senha
`email`	`string`	Sim	Email
`max_sends`	`number`	Não	Limite de envios por mês
`max_suscribers`	`number`	Não	Limite de assinantes
`creditos`	`number`	Não	Créditos iniciais

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "uname": "...",
  "pass": "...",
  "email": "...",
  "max_sends": 0,
  "max_suscribers": 0,
  "creditos": 0
}'

PUT/users/:idReseller

Atualizar subusuário

Parâmetros de rota

Nome	Descrição
`id`	ID do usuário a atualizar

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`max_sends`	`number`	Não	Limite de envios
`max_suscribers`	`number`	Não	Limite de assinantes
`active`	`number`	Não	1 = ativo, 0 = inativo

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "max_sends": 0,
  "max_suscribers": 0,
  "active": 0
}'

Resposta 200

{ "success": true }

PUT/users/:id/creditsReseller

Atualizar créditos de um usuário

Parâmetros de rota

Nome	Descrição
`id`	ID do usuário

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`amount`	`number`	Sim	Quantidade de créditos a atribuir

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/{ID}/credits" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0
}'

Resposta 200

{ "success": true }

GET/users/me/filesUsuário

Listar arquivos e pastas

Query params

Nome	Tipo	Obrig.	Default	Descrição
`folder`	`string`	Não	`/`	Caminho da pasta a listar

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/files" \
  -H "Authorization: Bearer $TOKEN"

POST/users/me/filesUsuário

Enviar arquivo

Content-Type: multipart/form-data. Validação de imagem com Sharp.

Request body · multipart/form-data

Nome	Tipo	Obrig.	Descrição
`file`	`file`	Sim	Arquivo de imagem
`folder`	`string`	Não	Pasta de destino (default: "/")

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/files" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "file": "<archivo>",
  "folder": "..."
}'

DELETE/users/me/filesUsuário

Excluir arquivo ou pasta

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`filePath`	`string`	Sim	Caminho do arquivo ou pasta

Exemplo

curl -X DELETE "https://envios.arrobamail.com/v3/api/users/me/files" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "filePath": "..."
}'

Resposta 200

{ "success": true }

POST/users/me/files/folderUsuário

Criar pasta

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`folderName`	`string`	Sim	Nome alfanumérico da pasta
`folder`	`string`	Não	Caminho base (default: "/")

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/users/me/files/folder" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "folderName": "...",
  "folder": "..."
}'

PUT/users/me/files/renameUsuário

Renomear arquivo ou pasta

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`filePath`	`string`	Sim	Caminho atual do arquivo/pasta
`newName`	`string`	Sim	Novo nome

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me/files/rename" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "filePath": "...",
  "newName": "..."
}'

Resposta 200

{ "success": true }

GET/users/me/ipsReseller

Listar IPs atribuídos

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/ips" \
  -H "Authorization: Bearer $TOKEN"

GET/users/me/ips/:ipReseller

Status e configuração de um IP

Parâmetros de rota

Nome	Descrição
`ip`	Endereço IP (ex.: 192.168.1.1)

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/me/ips/{IP}" \
  -H "Authorization: Bearer $TOKEN"

PUT/users/me/ips/:ip/hostnameReseller

Atualizar hostname do IP

Parâmetros de rota

Nome	Descrição
`ip`	Endereço IP

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`hostname`	`string`	Sim	Novo hostname

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me/ips/{IP}/hostname" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "hostname": "..."
}'

Resposta 200

{ "success": true }

PUT/users/me/smtps/:smtpId/ownerReseller

Alterar proprietário do SMTP

Parâmetros de rota

Nome	Descrição
`smtpId`	ID do servidor SMTP

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`userId`	`number`	Sim	ID do novo proprietário

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me/smtps/{SMTPID}/owner" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": 0
}'

Resposta 200

{ "success": true }

PUT/users/me/smtps/:smtpId/activateReseller

Ativar ou desativar SMTP

Parâmetros de rota

Nome	Descrição
`smtpId`	ID do servidor SMTP

Request body · application/json

Nome	Tipo	Obrig.	Descrição
`active`	`boolean`	Sim	true para ativar, false para desativar

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/users/me/smtps/{SMTPID}/activate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "active": true
}'

Resposta 200

{ "success": true }

GET/users/:id/sendersReseller

Remetentes de um usuário

Parâmetros de rota

Nome	Descrição
`id`	ID do usuário

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/users/{ID}/senders" \
  -H "Authorization: Bearer $TOKEN"

Comece com o arrobaMail
em menos de 5 minutos.

Plano Gratuito, gerações de IA incluídas, sem cartão de crédito e suporte real em português.

Testar grátis agora

Users /users

Dados do usuário autenticado

Atualizar perfil próprio

Alterar senha

Créditos de IA disponíveis

Configuração pública global para a UI

Listar Kits de marca próprios

Analisar URL para Kit de marca

Analisar campanhas anteriores para Kit de marca

Criar Kit de marca

Atualizar Kit de marca

Ativar Kit de marca

Dados de um usuário específico

Listar subusuários

Criar subusuário

Atualizar subusuário

Atualizar créditos de um usuário

Listar arquivos e pastas

Enviar arquivo

Excluir arquivo ou pasta

Criar pasta

Renomear arquivo ou pasta

Listar IPs atribuídos

Status e configuração de um IP

Atualizar hostname do IP

Alterar proprietário do SMTP

Ativar ou desativar SMTP

Remetentes de um usuário

Comece com o arrobaMailem menos de 5 minutos.

Users `/users`

Comece com o arrobaMail
em menos de 5 minutos.