Email (1.0.0)

Everything about Email Delivery Receipt Automations

View Email Delivery Receipt Rules

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

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/email/receipts

Request samples

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

Response samples

200

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
}
]
}

Create Email Delivery Receipt Rule

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

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/automations/email/receipts

Request samples

application/json

{"rule_name": "My Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://test.com?test=1234",
"enabled": 1
}

Response samples

200

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

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

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/automations/email/receipts/{receipt_rule_id}

Request samples

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

Response samples

200

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

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

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/automations/email/receipts/{receipt_rule_id}

Request samples

application/json

{"rule_name": "My Rule",
"match_type": 0,
"action": "URL",
"action_address": "http://test.com?test=1234",
"enabled": 1
}

Response samples

200

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

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

Request

path Parameters

receipt_rule_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

delete/v3/automations/email/receipts/{receipt_rule_id}

Request samples

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

Response samples

200

application/json

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