Import Contacts to List

POST

/lists/{list_id}/import

Contact Lists

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/lists/437/import' \
--header 'Content-Type: application/json' \
--data-raw '{
    "field_order": [
        "phone",
        "first_name",
        "last_name",
        "custom1",
        "custom2",
        "custom3",
        "custom4",
        "fax_number",
        "organization_name",
        "email",
        "address_line_1",
        "address_line_2",
        "address_city",
        "address_state",
        "address_postal_code",
        "address_country"
    ],
    "file_url": "http://yourdomain.com/import.csv"
}'

Response Example

{
    "data": {
        "id": "6254358460638066203",
        "ids": [
            "6254358460638066203"
        ],
        "msg": "Messages put on queue."
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Your file is now queued."
}

Request

Path Params

list_id

number

required

Your contact list id you want to access.

Example:

437

Body Params application/json

field_order

array

required

Your field order for your contact import file.

file_url

string

required

Path to your CSV import file.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Export Contacts List

Show CSV Import File Preview