Keep Your Contacts Organized

To make sending messages easier, you can use contacts instead of phone numbers. Your contacts will be safely kept on Textmagic servers and will be available from any location. This page shows how to create, edit and delete contacts.

Get all contacts

To retrieve all contacts, use:

GET /api/v2/contacts

with the parameters:

You will receive the standard paginated response:

Get the details of a specific contact

To get a single contact, use:

GET /api/v2/contacts/{id}

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

You will receive a response in the following format:

Country resource structure

You will receive a response in the following format:

Get all the lists in which the contact is included

To get all lists that the contact is assigned to, use:

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

where id is a contact ID, with these parameters:

You will receive the standard paginated response:

Add a new contact

To add a new contact, use:

POST /api/v2/contacts

with the following parameters:

If successful, you will receive the standard link response:

Edit a contact

To modify contact metadata, use:

PUT /api/v2/contacts/{id}

where id is contact ID, use the same parameters as when creating a contact:

If successful, you will receive the standard link response:

Delete a contact

To delete a contact, use the following command:

DELETE /api/v2/contacts/{id}

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

Get all unsubscribed contacts

When one of your message recipients sends a request with one of the STOP-words, they will be immediately opted-out of your send lists and their contact status will change to an unsubscribed contact. To retrieve information on all contacts who have unsubscribed, use:

GET /api/v2/unsubscribers

with the parameters:

You will receive the standard paginated response:

Get the details of a specific unsubscribed contact

To get a single contact, use:

GET /api/v2/unsubscriber/{id}

where id is an unsubscribed contact ID. Note, this command has no parameters.

You will receive a response in the following format:

Manually unsubscribe a contact

To unsubscribe a contact manually, use:

POST /api/v2/unsubscribers

with the following parameters:

If successful, you will receive the standard link response:

The next step

Now you’ve learned how to manage contacts via Textmagic API, in the next section, we will show how you can store extra contact data in custom fields.