Bulk Add Contacts from CSV File

post

https://api.transmitsms.com/add-contacts-bulk.json

Add bulk contacts to a list from a file

The add-contacts-bulk request can be used to add a CSV file of contacts to an existing list. It can also be used to create a new list and upload a CSV file of contacts to it. If a contact is added that already exists in a list, any existing data will be updated.

The return code 200 is only used to indicate that the API call has successfully hit our server. It in no way indicates if the contacts have been added\updated successfully. To find the status of an upload, including error messages, you must use the add-contacts-bulk-progress endpoint.

CSV File Format and Example:
        Firstname,Lastname,Mobile,"Custom Field 1"
        Jane,Doe,61412345678,10.44

The minimum required for successful import is Mobile.

The order above must be followed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

list_id

integer

required

ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. Required if name is not set.

name

string

required

Name of the list to create and add contacts to. If set, a new list will be created with this name. The list ID will be returned in the API response. Required if list_id is not set.

countrycode

string

Format the number in international format. 2-letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery.

file_url

string

URL location of the CSV file containing the contact list.

Must be a direct URL to the file, cannot be a redirected URL.
Cannot be a file on a local machine.
File must contain a column with the header ‘mobile’
To maximise API performance no error will be returned if call fails. ID returned in response will be automatically deleted.
To get status of call use add-contacts-bulk-progress
Basic auth can be used to secure file eg. https://username:[email protected]/file

field_n

string

Create or map a custom field.

There are 10 custom field slots available. The value n is the number of the custom field slot 1 through 10.
Create a field name using field_n=name e.g. field_1=email.
Headers in your file that match the custom field name will be automatically mapped. e.g. Column in CSV file named email will be automatically mapped to field_1=email.
If name contains spaces or symbols, other than letters or numbers, these must be URL encoded

Response

200Successful response containing the list ID and error details.