Messaging

View Allowed Emails

Email To SMS

Everything about Email to SMS

Servers

https://rest.clicksend.com/

View Allowed Emails

Request

Get list of email to sms allowed addresses

Parameters

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.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/sms/email-sms'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are some data."

dataArray of objects

Example: [{"email_address_id":84,"email_address":"my@email.com","from":"+13523944199"},{"email_address_id":85,"email_address":"my@email.com","from":"+13523944199"}]

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are some data.",
  "data": [
    { … },
    { … }
  ]
}

Add Allowed Email

Request

Create email to sms allowed address

Properties

Name	Type	Required	Restrictions	Description
email_address	string	true	none	Your email address
from	string	false	yes	Your sender id

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

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

email_addressstring

Example: "test@test.com"

fromstring

Example: "test"

from_faxstring

Example: "0411111111"

subaccount_idstring

Example: "{{subaccountId}}"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \

     --data-binary "    {
        \"email_address\":\"Cv3p0@gmail.com\",
        \"from\":\"+17128845887\"
    }" \
'https://rest.clicksend.com/v3/sms/email-sms'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "New data has been saved."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New data has been saved.",
  "data": {
    "email_address_id": 107,
    "email_address": "Cv3p0@gmail.com",
    "from": "+17128845887"
  }
}

View Stripped String Rules

Request

Get list of email to sms stripped string rules

Get list of email to sms stripped string rules

Parameters

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.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "New data has been saved."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New data has been saved.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "data": [ … ]
  }
}

Create Stripped String Rule

Request

Create email to sms stripped string rule

Create email to sms stripped string rules

Parameters

Parameter	In	Type	Required	Description
stripped-string	body	string	true	String to be stripped.

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

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

strip_stringstring

Example: "test"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"strip_string\" : \"~~~test~~~\"
}" \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Strip string has been created."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Strip string has been created.",
  "data": {
    "rule_id": 20,
    "strip_string": "test"
  }
}

View Stripped String Rule

Request

Get email to sms stripped string rule

Get email to sms stripped string rule

Parameters

Parameter	In	Type	Required	Description
rule_id	path	integer(int32)	true	Your rule id

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

This endpoint requires authentication,more info...

Path

rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings/{rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here is your result."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here is your result.",
  "data": {
    "rule_id": 18,
    "stripped_string": "You've received a reply from."
  }
}

Update Stripped String Rule

Request

Update email to sms stripped string rule

Update email to sms stripped string rule

Parameters

Parameter	In	Type	Required	Description
rule_id	path	integer(int32)	true	Your rule id
stripped-string	body	string	true	String to be stripped.

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

This endpoint requires authentication,more info...

Path

rule_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

strip_stringstring

Example: "test"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"strip_string\" : \"~~~test1~~~\"
}" \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings/{rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Strip string has been updated."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Strip string has been updated.",
  "data": {
    "rule_id": 20,
    "stripped_string": "~~~~test1~~~~"
  }
}

Delete Stripped String Rule

Request

Delete email to sms stripped string rule

Delete email to sms stripped string rule

Parameters

Parameter	In	Type	Required	Description
rule_id	path	integer(int32)	true	Your rule id

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

This endpoint requires authentication,more info...

Path

rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/sms/email-sms-stripped-strings/{rule_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Strip string has been deleted."

databoolean

Example: true

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Strip string has been deleted.",
  "data": true
}

Email To SMS

View Allowed Emails

Request

Parameters

Responses

Was this helpful?

Add Allowed Email

Request

Properties

Responses

Was this helpful?

View Stripped String Rules

Request

Parameters

Responses

Was this helpful?

Create Stripped String Rule

Request

Parameters

Responses

Was this helpful?

View Stripped String Rule

Request

Parameters

Responses

Was this helpful?

Update Stripped String Rule

Request

Parameters

Responses

Was this helpful?

Delete Stripped String Rule

Request

Parameters

Responses

Was this helpful?