Email

View Email Delivery Receipt Rules

Request

Get all email delivery receipt automations

Get all email delivery receipt automations

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...

Security

basicAuth

Headers

Content-Typestring

Example: application/json

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

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": [
    { … }
  ]
}

Create Email Delivery Receipt Rule

Request

Create email delivery receipt automations

Create email delivery receipt automations

Properties

Name	Type	Required	Restrictions	Description
rule_name	string	true	none	Rule Name.
match_type	number	true	none	Match Type. 0=All reports.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.

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

This endpoint requires authentication,more info...

Security

basicAuth

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

rule_namestring

Example: "My Rule"

match_typeinteger

actionstring

Example: "URL"

action_addressstring

Example: "http://test.com?test=1234"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"rule_name\":\"My Rule\",
        \"match_type\": 0,
        \"action\":\"URL\",
        \"action_address\":\"http://yourdomain.com\",
        \"enabled\":1
    }" \
'https://rest.clicksend.com/v3/automations/email/receipt'

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: "Automation email receipt rule has been created."

dataobject(email_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Automation email receipt rule has been created.",
  "data": {
    "receipt_rule_id": 1,
    "rule_name": "Email Test Rule",
    "match_type": 0,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

View Email Delivery Receipt Rule

Request

Get specific email delivery receipt automation

Get specific email delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

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

This endpoint requires authentication,more info...

Security

basicAuth

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/email/receipt/{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(email_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here is your result.",
  "data": {
    "receipt_rule_id": 1,
    "rule_name": "Email Test Rule",
    "match_type": 0,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

Update Email Delivery Receipt Rule

Request

Update email delivery receipt automation

Update email delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

Properties

Name	Type	Required	Restrictions	Description
rule_name	string	true	none	Rule Name.
match_type	number	true	none	Match Type. 0=All reports.
action	string	true	none	Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
action_address	string	true	none	Action address.
enabled	number	true	none	Enabled: Disabled=0 or Enabled=1.

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

This endpoint requires authentication,more info...

Security

basicAuth

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

rule_namestring

Example: "My Rule"

match_typeinteger

actionstring

Example: "URL"

action_addressstring

Example: "http://test.com?test=1234"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"rule_name\":\"My Rule\",
        \"match_type\": 0,
        \"action\":\"URL\",
        \"action_address\":\"http://yourdomain.com\",
        \"enabled\":1
    }" \
'https://rest.clicksend.com/v3/automations/email/receipt/{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: "Automation email receipt rule has been updated."

dataobject(email_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Automation email receipt rule has been updated.",
  "data": {
    "receipt_rule_id": 1,
    "rule_name": "Email Test Rule",
    "match_type": 0,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

Delete Email Delivery Receipt Rule

Request

Delete email delivery receipt automation

Delete email delivery receipt automation

Parameters

Parameter	In	Type	Required	Description
receipt_rule_id	path	integer(int32)	true	Receipt rule id

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

This endpoint requires authentication, more info...

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

This endpoint requires authentication,more info...

Security

basicAuth

Path

receipt_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/automations/email/receipt/{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: "Automation email receipt rule has been deleted."

databoolean

Example: true

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Automation email receipt rule has been deleted.",
  "data": true
}

Email

View Email Delivery Receipt Rules

Request

Parameters

Responses

Was this helpful?

Create Email Delivery Receipt Rule

Request

Properties

Responses

Was this helpful?

View Email Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?

Update Email Delivery Receipt Rule

Request

Parameters

Properties

Responses

Was this helpful?

Delete Email Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?