arrobaMail
Module 0513 endpoints

Segmentations /segmentations

Available in legacy and V2 versions (condition groups).

Endpoints

13 total
GET/segmentations/conditionsUser

Available conditions and operators

Always includes the user's custom fields under Subscriber Data; with listIds, filters those fields to the given lists.

Query params

NameTypeReq.DefaultDescription
langstringNoesLanguage: "es" or "en"
listIdsstringNo-Comma-separated list IDs to limit the custom fields; also accepts all

Example

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

List legacy segmentations

Example

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

Legacy segmentation detail

Path parameters

NameDescription
idNumeric segmentation ID (legacy)

Example

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

List V2 segmentations

Query params

NameTypeReq.DefaultDescription
typestringNo-Filter by type
isActivebooleanNo-Filter by active status

Example

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

V2 segmentation detail with groups and conditions

Path parameters

NameDescription
idNumeric V2 segmentation ID

Example

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

Create V2 segmentation

Name required (max 200 chars). Conditions must be valid.

Request body · application/json

NameTypeReq.Description
namestringYesSegmentation name (max 200 chars)
groupsarrayYesArray of condition groups
listIdsarrayNoAssociated list IDs
isActivebooleanNoDefault: true

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "groups": [],
  "listIds": [],
  "isActive": true
}'
PUT/segmentations/v2/:idUser

Update V2 segmentation

Path parameters

NameDescription
idV2 segmentation ID

Request body · application/json

NameTypeReq.Description
namestringNoName
groupsarrayNoCondition groups
isActivebooleanNoActive status

Example

curl -X PUT "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "groups": [],
  "isActive": true
}'

Response 200

{ "success": true }
DELETE/segmentations/v2/:idUser

Delete V2 segmentation

Path parameters

NameDescription
idV2 segmentation ID

Example

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

Response 200

{ "success": true }
POST/segmentations/v2/:id/duplicateUser

Duplicate V2 segmentation

Path parameters

NameDescription
idV2 segmentation ID to duplicate

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/duplicate" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/v2/:id/countUser

Count subscribers matching the segmentation

Path parameters

NameDescription
idV2 segmentation ID

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/count" \
  -H "Authorization: Bearer $TOKEN"

Response 200

{ "count": 1240 }
POST/segmentations/v2/:id/previewUser

Preview matching subscribers

Path parameters

NameDescription
idV2 segmentation ID

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/v2/{ID}/preview" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/migrate/:idUser

Migrate legacy segmentation to V2

Path parameters

NameDescription
idLegacy segmentation ID to migrate

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/migrate/{ID}" \
  -H "Authorization: Bearer $TOKEN"
POST/segmentations/migrate-allUser

Migrate all legacy segmentations to V2

Example

curl -X POST "https://envios.arrobamail.com/v3/api/segmentations/migrate-all" \
  -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
WhatsAppOur team replies