Merge Your Contacts Into Lists

With the Lists API, you can arrange your database contacts into different lists for sending targeted bulk text messages.

Get all lists

To get all lists, use:

GET /api/v2/lists

with these parameters:

You will receive the standard paginated response:

Get the details of a specific list

To get a single list, use:

GET /api/v2/lists/{id}

where id is a list ID. Note, this command has no parameters.

You will receive a response in the following format:

Create a new list

To create a new list, use:

POST /api/v2/lists

with the following parameters:

If successful, you will receive the standard link response:

Edit a list

To modify a list, use:

PUT /api/v2/lists/{id}

where id is a list ID. The command uses the same parameters as those used when creating it:

If successful, you will receive the standard link response:

Delete a list

To delete a list,use:

DELETE /api/v2/lists/{id}

where id is a list ID. Note, this command has no parameters. If successful, this command will return the standard delete response (204 No Content), otherwise a standard error response will be returned.

Get all contacts in a list

To get all contacts assigned to a list, use:

GET /api/v2/lists/{id}/contacts

where id is a list ID, with these parameters:

You will receive the standard paginated response:

Assign contacts to a list

To assign contacts to a specified list,use

PUT /api/v2/lists/{id}/contacts

where id is a list ID, with the following parameters:

If successful, you will receive the standard link response:

Remove contacts from a list

To remove contacts from a list,use:

DELETE /api/v2/lists/{id}/contacts

where id is a list ID. This command has the following parameters:

If successful, you will receive the standard link response:

The next step

You’ve now learned how to manage lists via Textmagic API. Please continue to the next section to learn how to manage Contacts.