Choose the right postage when sending on the API Are you sending personal information, or marketing content? Before you send your mail, know the key difference between First-Class and USPS Marketing Mail. Read our blog to find out more.
List Groups
Use the API to obtain a list of the mailing groups on your account. You can use the offset and limit parameters for pagination.
[GET]
https://api-us1.stannp.com/v1/groups/list
Parameters
| Parameter | Details | Description |
|---|---|---|
| offset | int optional | Offset for pagination. |
| limit | int optional | Limit for pagination. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/list" \
-u {API_KEY}:
Response Example
{
"success": true,
"data": [
{
"id": "398",
"account_id": "1",
"name": "Test Group",
"created": "2015-09-25 11:57:35",
"recipients": "100",
"valid": "98",
"international": "0",
"skipped": "0",
"status": "ready",
"import_progress": "0",
"is_seeds": "0"
},
{
"id": "390",
"account_id": "1",
"name": "My Data",
"created": "2015-09-23 10:50:48",
"recipients": "6000",
"valid": "5872",
"international": "0",
"skipped": "0",
"status": "ready",
"import_progress": "0",
"is_seeds": "0"
}
]
}Create Group
Use the API to create a new empty mailing list.
[POST]
https://api-us1.stannp.com/v1/groups/new
Parameters
| Parameter | Details | Description |
|---|---|---|
| name | str required | Name of the new group to be created. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/new" \
-u {API_KEY}: \
-d "name=My Group"
Response Example
{
"success": true,
"data": "39"
}Add Recipients to Group
Use the API to add recipients from your account to an existing mailing list.
[POST]
https://api-us1.stannp.com/v1/groups/add/:group_id
Parameters
| Parameter | Details | Description |
|---|---|---|
| recipients | str required | Comma-separated recipient IDs. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/add/:group_id" \
-u {API_KEY}: \
-d "recipients=45112,45113"
Response Example
{
"success": true,
"data": 2
}Remove Recipients from Group
Remove recipients from the group. Note that this only removes the recipient from the group and does not completely delete the recipient.
[POST]
https://api-us1.stannp.com/v1/groups/remove/:group_id
Parameters
| Parameter | Details | Description |
|---|---|---|
| recipients | str required | Comma-separated recipient IDs. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/remove/:group_id" \
-u {API_KEY}: \
-d "recipients=45112,45113"
Response Example
{
"success": true,
"data": 2
}Purge a Group
Use the API to remove all recipients from the mailing list. The recipients will remain on your account if delete_recipients is set to false.
[POST]
https://api-us1.stannp.com/v1/groups/purge
Parameters
| Parameter | Details | Description |
|---|---|---|
| id | int required | ID of the group to purge. |
| delete_recipients | bool optional | True or false. Delete all recipients in this group if true. Defaults to false. WARNING: If true this will completely delete the recipients so they will not exist in any other groups if the recipient was in multiple groups. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/purge" \
-u {API_KEY}: \
-d "id=123"
Response Example
{
"success": true,
"data": true
}Recalculate Group
Will recalculate a group to make sure stats are up to date.
[POST]
https://api-us1.stannp.com/v1/groups/calculate/:group_id
Request Example
curl "https://api-us1.stannp.com/v1/groups/calculate/:group_id" \
-u {API_KEY}:
Response Example
{
"success": true,
"data": true
}Delete a Group
Use the API to delete a mailing list. The recipients will remain on your account if delete_recipients is set to false.
[POST]
https://api-us1.stannp.com/v1/groups/delete
Parameters
| Parameter | Details | Description |
|---|---|---|
| id | int required | ID of the group to delete. |
| delete_recipients | bool optional | True or false. Defaults to false. WARNING: If true this will completely delete the recipients so they will not exist in any other groups if the recipient was in multiple groups. |
Request Example
curl "https://api-us1.stannp.com/v1/groups/delete" \
-u {API_KEY}: \
-d "id=123"
Response Example
{
"success": true,
"data": true
}