International Messaging (1.0.0)

Endpoints associated with creating and managing user accounts.

Select Countries for Global Sending

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.

Properties

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.

This endpoint requires authentication, more info...

Request

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/user-countries

Request samples

Payload
curl

application/json

{"country_list_ids": [1
]
}

Response samples

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your countries selection.",
"data": [{"id": 1,
"name": "Australia",
"code": "AU",
"region": "Oceania",
"agreed_at": null,
"registration_entity": null,
"registration_status": {"id": 1,
"name": "NOT_INITIATED"
},
"jotform_id": "12345",
"sms_registration_type": 0,
"block_registration": 0,
"block_leads": 0,
"trial_from_address": "",
"restricted_sending": 0,
"trial_sending": 0,
"trial_sending_description": "",
"has_regulation_requirements": 0,
"registration_steps_url": "https://clicksend.helpdocs.com",
"regulation_requirements_description": "You can only send from a Dedicated ShortCode. Marketing Messages must be sent from a zero-rated shortcode. Messages must comply with DIA guidelines including opt-in consent and a way to opt-out. https://help.clicksend.com/article/7ifkmw5vd5-australia%22"
}
]
}

Get Countries for Global Sending

Get Countries for global sending

Get the list of selected countries.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Responses

200

Successful response

get/v3/user-countries

Request samples

curl

curl --location 'https://rest.clicksend.com/v3/user-countries' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \

Response samples

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your countries selection.",
"data": [{"id": 1,
"name": "Australia",
"code": "AU",
"region": "Oceania",
"agreed_at": null,
"registration_entity": null,
"registration_status": {"id": 1,
"name": "NOT_INITIATED"
},
"jotform_id": "12345",
"sms_registration_type": 0,
"block_registration": 0,
"block_leads": 0,
"trial_from_address": "",
"restricted_sending": 0,
"trial_sending": 0,
"trial_sending_description": "",
"has_regulation_requirements": 0,
"registration_steps_url": "https://clicksend.helpdocs.com",
"regulation_requirements_description": "You can only send from a Dedicated ShortCode. Marketing Messages must be sent from a zero-rated shortcode. Messages must comply with DIA guidelines including opt-in consent and a way to opt-out. https://help.clicksend.com/article/7ifkmw5vd5-australia%22"
}
]
}

Agree to rules and regulation

Update Country Rule

To agree on rules and regulations of selected countries and confirm selection.

Properties

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.

This endpoint requires authentication, more info...

Request

Responses

200

Successful response

post/v3/user-countries/agree

Request samples

curl

curl --location --request POST 'https://rest.clicksend.com/v3/user-countries/agree' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==' \

Response samples

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your countries selection.",
"data": [{"id": 1,
"name": "Australia",
"code": "AU",
"region": "Oceania",
"agreed_at": null,
"registration_entity": null,
"registration_status": {"id": 1,
"name": "NOT_INITIATED"
},
"jotform_id": "12345",
"sms_registration_type": 0,
"block_registration": 0,
"block_leads": 0,
"trial_from_address": "",
"restricted_sending": 0,
"trial_sending": 0,
"trial_sending_description": "",
"has_regulation_requirements": 0,
"registration_steps_url": "https://clicksend.helpdocs.com",
"regulation_requirements_description": "You can only send from a Dedicated ShortCode. Marketing Messages must be sent from a zero-rated shortcode. Messages must comply with DIA guidelines including opt-in consent and a way to opt-out. https://help.clicksend.com/article/7ifkmw5vd5-australia%22"
}
]
}