Endpoints associated with creating and managing user accounts.
Endpoints associated with creating and managing user accounts.
Select Countries
Use this endpoint to select countries that you intend to send sms / mms to. To remove / unselect a country, just remove the country id from the array in the payload.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country_list_ids | number | true | none | Country list ID's |
Refer to Status Codes for definitions of HTTP status code responses.
curl --location --request POST 'https://rest.clicksend.com/v3/user-countries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \
--data '{
"country_list_ids": [1, 2]
}'{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here are your countries selection.", "data": [ { … } ] }
Get Countries for global sending
Get the list of selected countries.
Refer to Status Codes for definitions of HTTP status code responses.
curl --location 'https://rest.clicksend.com/v3/user-countries' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here are your countries selection.", "data": [ { … } ] }
Update Country Rule
To agree on rules and regulations of selected countries and confirm selection.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country_list_ids | number | true | none | Country list ID's |
Refer to Status Codes for definitions of HTTP status code responses.
curl --location --request POST 'https://rest.clicksend.com/v3/user-countries/agree' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here are your countries selection.", "data": [ { … } ] }
List of countries
List of countries with IDs that can be used in selecting countries for Global sending.
Refer to Status Codes for definitions of HTTP status code responses.
curl --location 'https://rest.clicksend.com/v3/country-list' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "List of Countries.", "data": [ { … } ] }
Get all country codes
Get all countries
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
'https://rest.clicksend.com/v3/countries'{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "List of Countries.", "data": [ { … }, { … }, { … } ] }
Get supported list of timezones.
Get supported list of timezones.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer(int32) | false | Page number |
| limit | query | integer(int32) | false | Number of records per page |
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/timezones'Successful response
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "List of timezones.", "data": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "etc..." ] }