Module 0627 endpoints

Users `/users`

Endpoints marked as Reseller require a reseller role or higher.

Endpoints

27 total

GET/users/meUser

Authenticated user data

Example

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

Response 200

{
  "id": 1234, "uname": "usuario", "email": "[email protected]",
  "nombre": "John", "apellido": "Doe", "empresa": "My Company",
  "role": "user", "user_type": "pro", "parent_id": 100,
  "active": 1, "max_sends": 50000, "max_suscribers": 10000,
  "creditos": 45000, "reputation": 95, "lang": "en"
}

PUT/users/meUser

Update own profile

Request body · application/json

Name	Type	Req.	Description
`nombre`	`string`	No	Name
`apellido`	`string`	No	Last name
`email`	`string`	No	Email
`empresa`	`string`	No	Company
`telefono`	`string`	No	Phone
`lang`	`string`	No	"es" or "en"
`timezone`	`string`	No	Timezone (e.g. "America/Buenos_Aires")

Example

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": "..."
}'

Response 200

{ "success": true }

PUT/users/me/passwordUser

Change password

Invalidates all active sessions on all devices.

Request body · application/json

Name	Type	Req.	Description
`currentPassword`	`string`	Yes	Current password
`newPassword`	`string`	Yes	New password

Example

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

Response 200

{ "success": true }

GET/users/me/aicreditsUser

Available AI credits

Example

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

Response 200

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

GET/users/me/public-configUser

Global public configuration for the UI

Exposes safe values for the frontend by combining config.json and om_config. Includes event rate limits and test-send limits.

Example

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

Response 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-kitsUser

List own brand kits

Returns only the authenticated user's brand kits.

Example

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

Response 200

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

POST/users/me/brand-kits/analyze-urlUser

Analyze URL for brand kit

HTTPS only. Blocks shortened, private, internal URLs, and cross-host redirects.

Request body · application/json

Name	Type	Req.	Description
`url`	`string`	Yes	HTTPS URL of the site to analyze

Example

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": "..."
}'

Response 200

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

Errors

Status	Code	Description
400	`url_https_required`	The URL must use HTTPS
400	`url_shortener_not_allowed`	Host is on the URL-shortener blacklist
400	`url_private_host_not_allowed`	Private or internal host
400	`url_private_ip_not_allowed`	Private, link-local, or reserved IP
400	`url_cross_host_redirect_not_allowed`	Redirect to another host
402	`insufficient_credits`	Insufficient AI credits
429	`daily_limit_reached`	Daily AI limit reached
429	`monthly_limit_reached`	Monthly AI limit reached
429	`rate_limit_exceeded`	Too many consecutive analyses
500	`internal_error`	Internal, non-public error

POST/users/me/brand-kits/analyze-campaignsUser

Analyze past campaigns for brand kit

Analyzes up to 5 of your own campaigns.

Request body · application/json

Name	Type	Req.	Description
`campaignIds`	`number[]`	Yes	Own campaign IDs. Maximum 5.

Example

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]
}'

Response 200

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

Errors

Status	Code	Description
400	`missing_campaigns`	Empty or invalid list
400	`too_many_campaigns`	More than 5 campaigns
404	`campaign_not_found`	Campaign doesn't exist or doesn't belong to the user
402	`insufficient_credits`	Insufficient AI credits
429	`daily_limit_reached`	Daily AI limit reached
429	`monthly_limit_reached`	Monthly AI limit reached
429	`rate_limit_exceeded`	Too many consecutive analyses
500	`internal_error`	Internal, non-public error

POST/users/me/brand-kitsUser

Create brand kit

Creates an editable draft.

Request body · application/json

Name	Type	Req.	Description
`name`	`string`	No	Internal kit name
`brandName`	`string`	No	Brand name
`primaryColor`	`string`	No	Hex color #RRGGBB
`toneOfVoice`	`string`	No	Tone of voice

Example

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": "..."
}'

Response 201

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

Errors

Status	Code	Description
400	`invalid_brand_kit_color`	Invalid color
400	`invalid_text_density`	Invalid text density
500	`brand_kit_create_failed`	Could not create the record
500	`internal_error`	Internal, non-public error
503	`brand_kits_not_configured`	Database migration has not been applied yet

PATCH/users/me/brand-kits/:idUser

Update brand kit

Only allows updating your own kits. Increments revision.

Path parameters

Name	Description
`id`	Numeric kit ID

Request body · application/json

Name	Type	Req.	Description
`brandName`	`string`	No	Brand name
`visualStyle`	`string`	No	Visual style

Example

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": "..."
}'

Response 200

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

Errors

Status	Code	Description
400	`invalid_brand_kit_color`	Invalid color
400	`invalid_text_density`	Invalid text density
404	`brand_kit_not_found`	Doesn't exist or doesn't belong to the user
500	`internal_error`	Internal, non-public error
503	`brand_kits_not_configured`	Database migration has not been applied yet

POST/users/me/brand-kits/:id/activateUser

Activate brand kit

Marks the kit as active/default for future AI generations.

Path parameters

Name	Description
`id`	Numeric kit ID

Example

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

Response 200

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

Errors

Status	Code	Description
404	`brand_kit_not_found`	Doesn't exist or doesn't belong to the user
500	`internal_error`	Internal, non-public error
503	`brand_kits_not_configured`	Database migration has not been applied yet

GET/users/:idReseller

Data for a specific user

Path parameters

Name	Description
`id`	Numeric user ID

Example

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

GET/users/:id/listReseller

List sub-users

Path parameters

Name	Description
`id`	Parent reseller ID

Query params

Name	Type	Req.	Default	Description
`offset`	`number`	No	`0`	Offset
`limit`	`number`	No	`25`	Items per page
`userType`	`string`	No	`-`	Filter by user type
`searchString`	`string`	No	`-`	Search by email/username
`sortBy`	`string`	No	`-`	Sort field
`sortDesc`	`boolean`	No	`false`	Descending order

Example

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

POST/users/:idReseller

Create sub-user

Path parameters

Name	Description
`id`	Parent reseller ID

Request body · application/json

Name	Type	Req.	Description
`uname`	`string`	Yes	Username
`pass`	`string`	Yes	Password
`email`	`string`	Yes	Email
`max_sends`	`number`	No	Monthly send limit
`max_suscribers`	`number`	No	Subscriber limit
`creditos`	`number`	No	Initial credits

Example

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

Update sub-user

Path parameters

Name	Description
`id`	ID of the user to update

Request body · application/json

Name	Type	Req.	Description
`max_sends`	`number`	No	Send limit
`max_suscribers`	`number`	No	Subscriber limit
`active`	`number`	No	1 = active, 0 = inactive

Example

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
}'

Response 200

{ "success": true }

PUT/users/:id/creditsReseller

Update a user's credits

Path parameters

Name	Description
`id`	User ID

Request body · application/json

Name	Type	Req.	Description
`amount`	`number`	Yes	Number of credits to assign

Example

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

Response 200

{ "success": true }

GET/users/me/filesUser

List files and folders

Query params

Name	Type	Req.	Default	Description
`folder`	`string`	No	`/`	Folder path to list

Example

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

POST/users/me/filesUser

Upload file

Content-Type: multipart/form-data. Image validation with Sharp.

Request body · multipart/form-data

Name	Type	Req.	Description
`file`	`file`	Yes	Image file
`folder`	`string`	No	Destination folder (default: "/")

Example

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/filesUser

Delete file or folder

Request body · application/json

Name	Type	Req.	Description
`filePath`	`string`	Yes	File or folder path

Example

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

Response 200

{ "success": true }

POST/users/me/files/folderUser

Create folder

Request body · application/json

Name	Type	Req.	Description
`folderName`	`string`	Yes	Alphanumeric folder name
`folder`	`string`	No	Base path (default: "/")

Example

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/renameUser

Rename file or folder

Request body · application/json

Name	Type	Req.	Description
`filePath`	`string`	Yes	Current file/folder path
`newName`	`string`	Yes	New name

Example

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": "..."
}'

Response 200

{ "success": true }

GET/users/me/ipsReseller

List assigned IPs

Example

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

GET/users/me/ips/:ipReseller

Status and configuration of an IP

Path parameters

Name	Description
`ip`	IP address (e.g. 192.168.1.1)

Example

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

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

Update IP hostname

Path parameters

Name	Description
`ip`	IP address

Request body · application/json

Name	Type	Req.	Description
`hostname`	`string`	Yes	New hostname

Example

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": "..."
}'

Response 200

{ "success": true }

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

Change SMTP owner

Path parameters

Name	Description
`smtpId`	SMTP server ID

Request body · application/json

Name	Type	Req.	Description
`userId`	`number`	Yes	New owner ID

Example

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
}'

Response 200

{ "success": true }

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

Activate or deactivate SMTP

Path parameters

Name	Description
`smtpId`	SMTP server ID

Request body · application/json

Name	Type	Req.	Description
`active`	`boolean`	Yes	true to activate, false to deactivate

Example

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
}'

Response 200

{ "success": true }

GET/users/:id/sendersReseller

A user's senders

Path parameters

Name	Description
`id`	User ID

Example

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

Get started with arrobaMail
in under 5 minutes.

Free plan, AI generations included, no credit card required — and real support from a real team.

Try it free now

Users /users

Authenticated user data

Update own profile

Change password

Available AI credits

Global public configuration for the UI

List own brand kits

Analyze URL for brand kit

Analyze past campaigns for brand kit

Create brand kit

Update brand kit

Activate brand kit

Data for a specific user

List sub-users

Create sub-user

Update sub-user

Update a user's credits

List files and folders

Upload file

Delete file or folder

Create folder

Rename file or folder

List assigned IPs

Status and configuration of an IP

Update IP hostname

Change SMTP owner

Activate or deactivate SMTP

A user's senders

Get started with arrobaMailin under 5 minutes.

Users `/users`

Get started with arrobaMail
in under 5 minutes.