ClickSend

App · 25 actions

Send and price SMS, read messages and delivery receipts, and manage contact lists, contacts, and message templates.

Actions

ActionWhat it does
Cancel scheduled SMSCancel scheduled SMS.
Copy contactCopy contact.
Create contactCreate contact.
Create contact listCreate contact list.
Create SMS templateCreate SMS template.
Delete contactDelete contact.
Delete contact listDelete contact list.
Delete SMS templateDelete SMS template.
Estimate SMS priceEstimate SMS price.
Get accountGet account.
Get contactGet contact.
Get contact listGet contact list.
Get delivery receiptGet delivery receipt.
List contact listsList contact lists.
List contactsList contacts.
List delivery receiptsList delivery receipts.
List inbound SMSList inbound SMS.
List SMS historyList SMS history.
List SMS templatesList SMS templates.
Mark inbound SMS readMark inbound SMS read.
Send SMSSend SMS.
Transfer contactTransfer contact.
Update contactUpdate contact.
Update contact listUpdate contact list.
Update SMS templateUpdate SMS template.

Cancel scheduled SMS

Cancel scheduled SMS.

Inputs

Message IDmessage_idtextRequired
Message id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Copy contact

Copy contact.

Inputs

From listfrom_list_idtextRequired
From list id
Contact IDcontact_idtextRequired
Contact id
To listto_list_idtextRequired
To list id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Create contact

Create contact.

Inputs

Contact listlist_idtextRequired
List id
Phone numberphone_numbertextRequired
Phone number
First namefirst_nametext
First name
Last namelast_nametext
Last name
Emailemailtext
Email
Custom 1custom_1text
Custom 1
Custom 2custom_2text
Custom 2

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Create contact list

Create contact list.

Inputs

List namelist_nametextRequired
List name

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Create SMS template

Create SMS template.

Inputs

Template nametemplate_nametextRequired
Template name
BodybodytextRequired
Body

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Delete contact

Delete contact.

Inputs

Contact listlist_idtextRequired
List id
Contact IDcontact_idtextRequired
Contact id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Delete contact list

Delete contact list.

Inputs

Contact listlist_idtextRequired
List id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Delete SMS template

Delete SMS template.

Inputs

Templatetemplate_idtextRequired
Template id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Estimate SMS price

Estimate SMS price.

Inputs

TototextRequired
Recipient phone number in international format, including the country code.
BodybodytextRequired
The text message to send.
Sendersendertext
Your approved sender name or sending number.
Schedulescheduledate and time
Send at this time; leave blank to send now.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Get account

Get account.

Inputs

None.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Get contact

Get contact.

Inputs

Contact listlist_idtextRequired
List id
Contact IDcontact_idtextRequired
Contact id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Get contact list

Get contact list.

Inputs

Contact listlist_idtextRequired
List id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Get delivery receipt

Get delivery receipt.

Inputs

Message IDmessage_idtextRequired
Message id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List contact lists

List contact lists.

Inputs

Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List contacts

List contacts.

Inputs

Contact listlist_idtextRequired
List id
Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List delivery receipts

List delivery receipts.

Inputs

Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List inbound SMS

List inbound SMS.

Inputs

Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List SMS history

List SMS history.

Inputs

Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

List SMS templates

List SMS templates.

Inputs

Pagepagenumber
PageAt least 1. Default: 1.
Limitlimitnumber
LimitFrom 1 to 100. Default: 25.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Mark inbound SMS read

Mark inbound SMS read.

Inputs

Message IDmessage_idtextRequired
Message id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Send SMS

Send SMS.

Inputs

TototextRequired
Recipient phone number in international format, including the country code.
BodybodytextRequired
The text message to send.
Sendersendertext
Your approved sender name or sending number.
Schedulescheduledate and time
Send at this time; leave blank to send now.

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Transfer contact

Transfer contact.

Inputs

From listfrom_list_idtextRequired
From list id
Contact IDcontact_idtextRequired
Contact id
To listto_list_idtextRequired
To list id

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Update contact

Update contact.

Inputs

Contact listlist_idtextRequired
List id
Contact IDcontact_idtextRequired
Contact id
Phone numberphone_numbertext
Phone number
First namefirst_nametext
First name
Last namelast_nametext
Last name
Emailemailtext
Email
Custom 1custom_1text
Custom 1
Custom 2custom_2text
Custom 2

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Update contact list

Update contact list.

Inputs

Contact listlist_idtextRequired
List id
List namelist_nametextRequired
List name

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

Update SMS template

Update SMS template.

Inputs

Templatetemplate_idtextRequired
Template id
Template nametemplate_nametextRequired
Template name
BodybodytextRequired
Body

Outputs

dataobject
The ClickSend result, response status and pagination information.
Example output
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}

On this page