# ClickSend

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/clicksend

## Actions

### Cancel scheduled SMS

Cancel scheduled SMS.

**Inputs**

- Message ID (`message_id`, text, required): Message id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Copy contact

Copy contact.

**Inputs**

- From list (`from_list_id`, text, required): From list id
- Contact ID (`contact_id`, text, required): Contact id
- To list (`to_list_id`, text, required): To list id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Create contact

Create contact.

**Inputs**

- Contact list (`list_id`, text, required): List id
- Phone number (`phone_number`, text, required): Phone number
- First name (`first_name`, text): First name
- Last name (`last_name`, text): Last name
- Email (`email`, text): Email
- Custom 1 (`custom_1`, text): Custom 1
- Custom 2 (`custom_2`, text): Custom 2

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Create contact list

Create contact list.

**Inputs**

- List name (`list_name`, text, required): List name

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Create SMS template

Create SMS template.

**Inputs**

- Template name (`template_name`, text, required): Template name
- Body (`body`, text, required): Body

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Delete contact

Delete contact.

**Inputs**

- Contact list (`list_id`, text, required): List id
- Contact ID (`contact_id`, text, required): Contact id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Delete contact list

Delete contact list.

**Inputs**

- Contact list (`list_id`, text, required): List id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Delete SMS template

Delete SMS template.

**Inputs**

- Template (`template_id`, text, required): Template id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Estimate SMS price

Estimate SMS price.

**Inputs**

- To (`to`, text, required): Recipient phone number in international format, including the country code.
- Body (`body`, text, required): The text message to send.
- Sender (`sender`, text): Your approved sender name or sending number.
- Schedule (`schedule`, date and time): Send at this time; leave blank to send now.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Get account

Get account.

**Inputs**: None.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Get contact

Get contact.

**Inputs**

- Contact list (`list_id`, text, required): List id
- Contact ID (`contact_id`, text, required): Contact id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Get contact list

Get contact list.

**Inputs**

- Contact list (`list_id`, text, required): List id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Get delivery receipt

Get delivery receipt.

**Inputs**

- Message ID (`message_id`, text, required): Message id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List contact lists

List contact lists.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List contacts

List contacts.

**Inputs**

- Contact list (`list_id`, text, required): List id
- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List delivery receipts

List delivery receipts.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List inbound SMS

List inbound SMS.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List SMS history

List SMS history.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### List SMS templates

List SMS templates.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `25`.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Mark inbound SMS read

Mark inbound SMS read.

**Inputs**

- Message ID (`message_id`, text, required): Message id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Send SMS

Send SMS.

**Inputs**

- To (`to`, text, required): Recipient phone number in international format, including the country code.
- Body (`body`, text, required): The text message to send.
- Sender (`sender`, text): Your approved sender name or sending number.
- Schedule (`schedule`, date and time): Send at this time; leave blank to send now.

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Transfer contact

Transfer contact.

**Inputs**

- From list (`from_list_id`, text, required): From list id
- Contact ID (`contact_id`, text, required): Contact id
- To list (`to_list_id`, text, required): To list id

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Update contact

Update contact.

**Inputs**

- Contact list (`list_id`, text, required): List id
- Contact ID (`contact_id`, text, required): Contact id
- Phone number (`phone_number`, text): Phone number
- First name (`first_name`, text): First name
- Last name (`last_name`, text): Last name
- Email (`email`, text): Email
- Custom 1 (`custom_1`, text): Custom 1
- Custom 2 (`custom_2`, text): Custom 2

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Update contact list

Update contact list.

**Inputs**

- Contact list (`list_id`, text, required): List id
- List name (`list_name`, text, required): List name

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```

### Update SMS template

Update SMS template.

**Inputs**

- Template (`template_id`, text, required): Template id
- Template name (`template_name`, text, required): Template name
- Body (`body`, text, required): Body

**Outputs**

- `data` (object): The ClickSend result, response status and pagination information.

**Example output**

```json
{
  "data": {
    "data": {},
    "http_code": 1,
    "response_code": "example",
    "response_msg": "example"
  }
}
```
