Fax

View Fax Inbound Rules

Request

Get all inbound fax automations

Get all inbound fax 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/fax/inbound'

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: "Your inbound fax."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your inbound fax.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ]
  }
}

Create Fax Inbound Rule

Request

Create new inbound fax automation

Create new inbound fax automation

Properties

Name	Type	Required	Restrictions	Description
dedicated_number	string	true	none	Dedicated Number. Can be '*' to apply to all numbers.
rule_name	string	true	none	Rule Name.
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

dedicated_numberstring

Example: "*"

rule_namestring

Example: "test rule"

actionstring

Example: "URL"

action_addressstring

Example: "https://testzzz.com"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"dedicated_number\":\"+61298441484\",
        \"rule_name\":\"Rule Name\",
        \"action\":\"EMAIL_FIXED\",
        \"action_address\":\"email@domain.com\",
        \"enabled\":1
    }" \
'https://rest.clicksend.com/v3/automations/fax/inbound'

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 rule has been added."

dataobject(inbound_fax_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New rule has been added.",
  "data": {
    "inbound_rule_id": 1,
    "dedicated_number": "19",
    "rule_name": "Email",
    "user_id": 1,
    "action": "EMAIL_FIXED",
    "action_address": "test@test.com",
    "enabled": 1
  }
}

View Fax Inbound Rule

Request

Get specific inbound fax automation

Get specific inbound fax automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

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

This endpoint requires authentication,more info...

Security

basicAuth

Path

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/automations/fax/inbound/{inbound_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: "Your inbound fax."

dataobject(inbound_fax_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your inbound fax.",
  "data": {
    "inbound_rule_id": 1,
    "dedicated_number": "19",
    "rule_name": "Email",
    "user_id": 1,
    "action": "EMAIL_FIXED",
    "action_address": "test@test.com",
    "enabled": 1
  }
}

Update Fax Inbound Rule

Request

Update inbound fax automation

Update inbound fax automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

Properties

Name	Type	Required	Restrictions	Description
dedicated_number	string	true	none	Dedicated Number. Can be '*' to apply to all numbers.
rule_name	string	true	none	Rule Name.
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

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

dedicated_numberstring

Example: "+61411111111"

rule_namestring

Example: "test rule"

actionstring

Example: "URL"

action_addressstring

Example: "https://testzzz.com"

enabledinteger

Example: 1

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"dedicated_number\":\"+61298441484\",
        \"rule_name\":\"Rule Name\",
        \"action\":\"EMAIL_FIXED\",
        \"action_address\":\"email@domain.com\",
        \"enabled\":1
    }" \
'https://rest.clicksend.com/v3/automations/fax/inbound/{inbound_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: "Your inbound fax."

dataobject(inbound_fax_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your inbound fax.",
  "data": {
    "inbound_rule_id": 1,
    "dedicated_number": "19",
    "rule_name": "Email",
    "user_id": 1,
    "action": "EMAIL_FIXED",
    "action_address": "test@test.com",
    "enabled": 1
  }
}

Delete Fax Inbound Rule

Request

Delete inbound fax automation

Delete inbound fax automation

Parameters

Parameter	In	Type	Required	Description
inbound_rule_id	path	integer(int32)	true	Inbound rule id

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

This endpoint requires authentication,more info...

Security

basicAuth

Path

inbound_rule_idstringrequired

Headers

Content-Typestring

Example: application/json

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

dataArray of items

Example: []

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your fax inbound rule has been deleted.",
  "data": []
}

View FAX Delivery Receipt Rules

Request

Get all fax delivery receipt automations

Get all fax 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": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ]
  }
}

Create FAX Delivery Receipt Rule

Request

Create fax delivery receipt automations

Create fax 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: "test"

match_typeinteger

actionstring

Example: "URL"

action_addressstring

Example: "https://testzzz.com"

enabledinteger

Example: 1

urlstring

Example: "http://yourUrl.com"

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: "Your new Fax receipt has been added."

dataobject(fax_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your new Fax receipt has been added.",
  "data": {
    "receipt_rule_id": 1,
    "rule_name": "Email Test Rule",
    "match_type": 0,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

View FAX Delivery Receipt Rule

Request

Get specific fax delivery receipt automation

Get specific fax 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: "Your rule incoming fax receipt."

dataobject(fax_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming fax receipt.",
  "data": {
    "receipt_rule_id": 1,
    "rule_name": "Email Test Rule",
    "match_type": 0,
    "action": "URL",
    "action_address": "http://yourdomain.com",
    "enabled": 1
  }
}

Update FAX Delivery Receipt Rule

Request

Update fax delivery receipt automation

Update fax 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

action_addressstring

Example: "test.com"

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: "Your rule incoming fax receipt has been updated."

dataobject(fax_delivery_receipt_rule)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming fax receipt 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 FAX Delivery Receipt Rule

Request

Delete fax delivery receipt automation

Delete fax 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=="  \
     --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: "Your rule incoming fax receipt has been deleted."

dataobject or null

Example: null

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your rule incoming fax receipt has been deleted.",
  "data": null
}

Fax

View Fax Inbound Rules

Request

Parameters

Responses

Was this helpful?

Create Fax Inbound Rule

Request

Properties

Responses

Was this helpful?

View Fax Inbound Rule

Request

Parameters

Responses

Was this helpful?

Update Fax Inbound Rule

Request

Parameters

Properties

Responses

Was this helpful?

Delete Fax Inbound Rule

Request

Parameters

Responses

Was this helpful?

View FAX Delivery Receipt Rules

Request

Parameters

Responses

Was this helpful?

Create FAX Delivery Receipt Rule

Request

Properties

Responses

Was this helpful?

View FAX Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?

Update FAX Delivery Receipt Rule

Request

Parameters

Properties

Responses

Was this helpful?

Delete FAX Delivery Receipt Rule

Request

Parameters

Responses

Was this helpful?