> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# clicksend-fax-post

> ClickSend Fax & Post

**Server path:** `/clicksend-fax-post` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                                            | Description                                         |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| [`clicksend_fax_post_delivery_receipt_automation_delete`](#clicksend_fax_post_delivery_receipt_automation_delete)                               | Delete fax delivery receipt automation              |
| [`clicksend_fax_post_delivery_receipt_automation_get`](#clicksend_fax_post_delivery_receipt_automation_get)                                     | Get specific fax delivery receipt automation        |
| [`clicksend_fax_post_delivery_receipt_automation_post`](#clicksend_fax_post_delivery_receipt_automation_post)                                   | Create fax delivery receipt automations             |
| [`clicksend_fax_post_delivery_receipt_automation_put`](#clicksend_fax_post_delivery_receipt_automation_put)                                     | Update fax delivery receipt automation              |
| [`clicksend_fax_post_delivery_receipt_automations_get`](#clicksend_fax_post_delivery_receipt_automations_get)                                   | Get all fax delivery receipt automations            |
| [`clicksend_fax_post_history_get`](#clicksend_fax_post_history_get)                                                                             | Get a list of Fax History.                          |
| [`clicksend_fax_post_inbound_automation_delete`](#clicksend_fax_post_inbound_automation_delete)                                                 | Delete inbound fax automation                       |
| [`clicksend_fax_post_inbound_automation_get`](#clicksend_fax_post_inbound_automation_get)                                                       | Get specific inbound fax automation                 |
| [`clicksend_fax_post_inbound_automation_post`](#clicksend_fax_post_inbound_automation_post)                                                     | Create new inbound fax automation                   |
| [`clicksend_fax_post_inbound_automation_put`](#clicksend_fax_post_inbound_automation_put)                                                       | Update inbound fax automation                       |
| [`clicksend_fax_post_inbound_automations_get`](#clicksend_fax_post_inbound_automations_get)                                                     | Get all inbound fax automations                     |
| [`clicksend_fax_post_post_letters_export_get`](#clicksend_fax_post_post_letters_export_get)                                                     | export post letter history                          |
| [`clicksend_fax_post_post_letters_history_get`](#clicksend_fax_post_post_letters_history_get)                                                   | Get all post letter history                         |
| [`clicksend_fax_post_post_letters_price_post`](#clicksend_fax_post_post_letters_price_post)                                                     | Calculate post letter price                         |
| [`clicksend_fax_post_post_letters_send_post`](#clicksend_fax_post_post_letters_send_post)                                                       | Send post letter                                    |
| [`clicksend_fax_post_post_postcards_history_export_get`](#clicksend_fax_post_post_postcards_history_export_get)                                 | Export postcard history to a CSV file               |
| [`clicksend_fax_post_post_postcards_history_get`](#clicksend_fax_post_post_postcards_history_get)                                               | Retrieve the history of postcards sent or scheduled |
| [`clicksend_fax_post_post_postcards_price_post`](#clicksend_fax_post_post_postcards_price_post)                                                 | Calculate price for sending one or more postcards   |
| [`clicksend_fax_post_post_postcards_send_post`](#clicksend_fax_post_post_postcards_send_post)                                                   | Send one or more postcards                          |
| [`clicksend_fax_post_post_return_addresses_by_return_address_id_delete`](#clicksend_fax_post_post_return_addresses_by_return_address_id_delete) | Delete specific post return address                 |
| [`clicksend_fax_post_post_return_addresses_by_return_address_id_get`](#clicksend_fax_post_post_return_addresses_by_return_address_id_get)       | Get specific post return address                    |
| [`clicksend_fax_post_post_return_addresses_by_return_address_id_put`](#clicksend_fax_post_post_return_addresses_by_return_address_id_put)       | Update post return address                          |
| [`clicksend_fax_post_post_return_addresses_get`](#clicksend_fax_post_post_return_addresses_get)                                                 | Get list of post return addresses                   |
| [`clicksend_fax_post_post_return_addresses_post`](#clicksend_fax_post_post_return_addresses_post)                                               | Create post return address                          |
| [`clicksend_fax_post_price_post`](#clicksend_fax_post_price_post)                                                                               | Calculate Total Price for Fax Messages sent         |
| [`clicksend_fax_post_receipts_by_message_id_get`](#clicksend_fax_post_receipts_by_message_id_get)                                               | Get a single fax receipt based on message id.       |
| [`clicksend_fax_post_receipts_get`](#clicksend_fax_post_receipts_get)                                                                           | Get all delivery receipts                           |
| [`clicksend_fax_post_receipts_post`](#clicksend_fax_post_receipts_post)                                                                         | Add a delivery receipt                              |
| [`clicksend_fax_post_receipts_read_put`](#clicksend_fax_post_receipts_read_put)                                                                 | Mark delivery receipts as read                      |
| [`clicksend_fax_post_send_post`](#clicksend_fax_post_send_post)                                                                                 | Send a fax using supplied supported file-types.     |

***

## clicksend\_fax\_post\_delivery\_receipt\_automation\_delete

Delete fax delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_delivery\_receipt\_automation\_get

Get specific fax delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_delivery\_receipt\_automation\_post

Create fax delivery receipt automations

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                                                                                                                                                        |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action`         | string | Yes      | —       | 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 | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `enabled`        | number | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `match_type`     | number | Yes      | —       | Match Type. 0=All reports.                                                                                                                                                                                                         |
| `rule_name`      | string | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "action": {
        "type": "string",
        "description": "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": {
        "type": "string",
        "description": "Action address."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "match_type": {
        "type": "number",
        "description": "Match Type. 0=All reports."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "action",
      "action_address",
      "enabled",
      "match_type",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_delivery\_receipt\_automation\_put

Update fax delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description                                                                                                                                                                                                                        |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id                                                                                                                                                                                                                    |
| `action`          | string  | Yes      | —       | 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  | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `enabled`         | number  | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `match_type`      | number  | Yes      | —       | Match Type. 0=All reports.                                                                                                                                                                                                         |
| `rule_name`       | string  | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      },
      "action": {
        "type": "string",
        "description": "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": {
        "type": "string",
        "description": "Action address."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "match_type": {
        "type": "number",
        "description": "Match Type. 0=All reports."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id",
      "action",
      "action_address",
      "enabled",
      "match_type",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_delivery\_receipt\_automations\_get

Get all fax delivery receipt automations

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `q`       | string  | No       | —       | Your keyword or query.     |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "Your keyword or query."
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_history\_get

Get a list of Fax History.

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                             |
| ----------- | ------- | -------- | ------- | ----------------------------------------------------------------------- |
| `date_from` | integer | No       | —       | Customize result by setting from date (timestsamp) Example: 1457572619. |
| `date_to`   | integer | No       | —       | Customize result by setting to date (timestamp) Example: 1457573000.    |
| `q`         | string  | No       | —       | Custom query Example: status:Sent,status\_code:201.                     |
| `order`     | string  | No       | —       | Order result by Example: date\_added:desc,list\_id:desc.                |
| `page`      | integer | No       | —       | Page number                                                             |
| `limit`     | integer | No       | —       | Number of records per page                                              |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "date_from": {
        "type": "integer",
        "description": "Customize result by setting from date (timestsamp) Example: 1457572619."
      },
      "date_to": {
        "type": "integer",
        "description": "Customize result by setting to date (timestamp) Example: 1457573000."
      },
      "q": {
        "type": "string",
        "description": "Custom query Example: status:Sent,status_code:201."
      },
      "order": {
        "type": "string",
        "description": "Order result by Example: date_added:desc,list_id:desc."
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_inbound\_automation\_delete

Delete inbound fax automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `inbound_rule_id` | integer | Yes      | —       | Inbound rule id |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "inbound_rule_id": {
        "type": "integer",
        "description": "Inbound rule id"
      }
    },
    "required": [
      "PCID",
      "inbound_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_inbound\_automation\_get

Get specific inbound fax automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `inbound_rule_id` | integer | Yes      | —       | Inbound rule id |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "inbound_rule_id": {
        "type": "integer",
        "description": "Inbound rule id"
      }
    },
    "required": [
      "PCID",
      "inbound_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_inbound\_automation\_post

Create new inbound fax automation

**Parameters:**

| Parameter          | Type   | Required | Default | Description                                                                                                                                                                                                                        |
| ------------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action`           | string | Yes      | —       | 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 | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `dedicated_number` | string | Yes      | —       | Dedicated Number. Can be '\*' to apply to all numbers.                                                                                                                                                                             |
| `enabled`          | number | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `rule_name`        | string | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "action": {
        "type": "string",
        "description": "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": {
        "type": "string",
        "description": "Action address."
      },
      "dedicated_number": {
        "type": "string",
        "description": "Dedicated Number. Can be '*' to apply to all numbers."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "action",
      "action_address",
      "dedicated_number",
      "enabled",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_inbound\_automation\_put

Update inbound fax automation

**Parameters:**

| Parameter          | Type    | Required | Default | Description                                                                                                                                                                                                                        |
| ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `inbound_rule_id`  | integer | Yes      | —       | Inbound rule id                                                                                                                                                                                                                    |
| `action`           | string  | Yes      | —       | 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  | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `dedicated_number` | string  | Yes      | —       | Dedicated Number. Can be '\*' to apply to all numbers.                                                                                                                                                                             |
| `enabled`          | number  | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `rule_name`        | string  | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "inbound_rule_id": {
        "type": "integer",
        "description": "Inbound rule id"
      },
      "action": {
        "type": "string",
        "description": "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": {
        "type": "string",
        "description": "Action address."
      },
      "dedicated_number": {
        "type": "string",
        "description": "Dedicated Number. Can be '*' to apply to all numbers."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "inbound_rule_id",
      "action",
      "action_address",
      "dedicated_number",
      "enabled",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_inbound\_automations\_get

Get all inbound fax automations

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `q`       | string  | No       | —       | Your keyword or query.     |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "Your keyword or query."
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_letters\_export\_get

export post letter history

**Parameters:**

| Parameter  | Type   | Required | Default | Description           |
| ---------- | ------ | -------- | ------- | --------------------- |
| `filename` | string | Yes      | —       | Filename to export to |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filename": {
        "type": "string",
        "description": "Filename to export to"
      }
    },
    "required": [
      "PCID",
      "filename"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_letters\_history\_get

Get all post letter history

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_letters\_price\_post

Calculate post letter price

**Parameters:**

| Parameter       | Type      | Required | Default | Description                   |
| --------------- | --------- | -------- | ------- | ----------------------------- |
| `colour`        | integer   | No       | —       | Whether letter is in colour   |
| `duplex`        | integer   | No       | —       | Whether letter is duplex      |
| `file_url`      | string    | Yes      | —       | URL of file to send           |
| `priority_post` | integer   | No       | —       | Whether letter is priority    |
| `recipients`    | object\[] | Yes      | —       | Array of PostRecipient models |
| `source`        | string    | No       | —       | Source being sent from        |
| `template_used` | integer   | No       | —       | Whether using our template    |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "colour": {
        "type": "integer",
        "description": "Whether letter is in colour"
      },
      "duplex": {
        "type": "integer",
        "description": "Whether letter is duplex"
      },
      "file_url": {
        "type": "string",
        "description": "URL of file to send"
      },
      "priority_post": {
        "type": "integer",
        "description": "Whether letter is priority"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "address_name": {
              "type": "string",
              "description": "Name of address"
            },
            "address_line_1": {
              "type": "string",
              "description": "First line of address"
            },
            "address_line_2": {
              "type": "string",
              "description": "Second line of address"
            },
            "address_city": {
              "type": "string",
              "description": "City"
            },
            "address_state": {
              "type": "string",
              "description": "State"
            },
            "address_postal_code": {
              "type": "string",
              "description": "Postal code"
            },
            "address_country": {
              "type": "string",
              "description": "Country"
            },
            "return_address_id": {
              "type": "integer",
              "format": "int32",
              "description": "ID of return address to use"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "When to send letter (0/null=now)"
            }
          },
          "required": [
            "address_city",
            "address_country",
            "address_line_1",
            "address_name",
            "address_postal_code",
            "address_state",
            "return_address_id"
          ]
        },
        "description": "Array of PostRecipient models"
      },
      "source": {
        "type": "string",
        "description": "Source being sent from"
      },
      "template_used": {
        "type": "integer",
        "description": "Whether using our template"
      }
    },
    "required": [
      "PCID",
      "file_url",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_letters\_send\_post

Send post letter

**Parameters:**

| Parameter       | Type      | Required | Default | Description                   |
| --------------- | --------- | -------- | ------- | ----------------------------- |
| `colour`        | integer   | No       | —       | Whether letter is in colour   |
| `duplex`        | integer   | No       | —       | Whether letter is duplex      |
| `file_url`      | string    | Yes      | —       | URL of file to send           |
| `priority_post` | integer   | No       | —       | Whether letter is priority    |
| `recipients`    | object\[] | Yes      | —       | Array of PostRecipient models |
| `source`        | string    | No       | —       | Source being sent from        |
| `template_used` | integer   | No       | —       | Whether using our template    |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "colour": {
        "type": "integer",
        "description": "Whether letter is in colour"
      },
      "duplex": {
        "type": "integer",
        "description": "Whether letter is duplex"
      },
      "file_url": {
        "type": "string",
        "description": "URL of file to send"
      },
      "priority_post": {
        "type": "integer",
        "description": "Whether letter is priority"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "address_name": {
              "type": "string",
              "description": "Name of address"
            },
            "address_line_1": {
              "type": "string",
              "description": "First line of address"
            },
            "address_line_2": {
              "type": "string",
              "description": "Second line of address"
            },
            "address_city": {
              "type": "string",
              "description": "City"
            },
            "address_state": {
              "type": "string",
              "description": "State"
            },
            "address_postal_code": {
              "type": "string",
              "description": "Postal code"
            },
            "address_country": {
              "type": "string",
              "description": "Country"
            },
            "return_address_id": {
              "type": "integer",
              "format": "int32",
              "description": "ID of return address to use"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "When to send letter (0/null=now)"
            }
          },
          "required": [
            "address_city",
            "address_country",
            "address_line_1",
            "address_name",
            "address_postal_code",
            "address_state",
            "return_address_id"
          ]
        },
        "description": "Array of PostRecipient models"
      },
      "source": {
        "type": "string",
        "description": "Source being sent from"
      },
      "template_used": {
        "type": "integer",
        "description": "Whether using our template"
      }
    },
    "required": [
      "PCID",
      "file_url",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_postcards\_history\_export\_get

Export postcard history to a CSV file

**Parameters:**

| Parameter  | Type   | Required | Default | Description           |
| ---------- | ------ | -------- | ------- | --------------------- |
| `filename` | string | Yes      | —       | Filename to export to |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filename": {
        "type": "string",
        "description": "Filename to export to"
      }
    },
    "required": [
      "PCID",
      "filename"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_postcards\_history\_get

Retrieve the history of postcards sent or scheduled

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_postcards\_price\_post

Calculate price for sending one or more postcards

**Parameters:**

| Parameter    | Type      | Required | Default | Description         |
| ------------ | --------- | -------- | ------- | ------------------- |
| `file_urls`  | string\[] | Yes      | —       | Postcard file URLs  |
| `recipients` | object\[] | Yes      | —       | Array of recipients |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "file_urls": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Postcard file URLs"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "address_name": {
              "type": "string",
              "description": "Name of address"
            },
            "address_line_1": {
              "type": "string",
              "description": "First line of address"
            },
            "address_line_2": {
              "type": "string",
              "description": "Second line of address"
            },
            "address_city": {
              "type": "string",
              "description": "City"
            },
            "address_state": {
              "type": "string",
              "description": "State"
            },
            "address_postal_code": {
              "type": "string",
              "description": "Postal code"
            },
            "address_country": {
              "type": "string",
              "description": "Country"
            },
            "return_address_id": {
              "type": "integer",
              "format": "int32",
              "description": "ID of return address to use"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "When to send letter (0/null=now)"
            }
          },
          "required": [
            "address_city",
            "address_country",
            "address_line_1",
            "address_name",
            "address_postal_code",
            "address_state",
            "return_address_id"
          ]
        },
        "description": "Array of recipients"
      }
    },
    "required": [
      "PCID",
      "file_urls",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_postcards\_send\_post

Send one or more postcards

**Parameters:**

| Parameter    | Type      | Required | Default | Description         |
| ------------ | --------- | -------- | ------- | ------------------- |
| `file_urls`  | string\[] | Yes      | —       | Postcard file URLs  |
| `recipients` | object\[] | Yes      | —       | Array of recipients |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "file_urls": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Postcard file URLs"
      },
      "recipients": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "address_name": {
              "type": "string",
              "description": "Name of address"
            },
            "address_line_1": {
              "type": "string",
              "description": "First line of address"
            },
            "address_line_2": {
              "type": "string",
              "description": "Second line of address"
            },
            "address_city": {
              "type": "string",
              "description": "City"
            },
            "address_state": {
              "type": "string",
              "description": "State"
            },
            "address_postal_code": {
              "type": "string",
              "description": "Postal code"
            },
            "address_country": {
              "type": "string",
              "description": "Country"
            },
            "return_address_id": {
              "type": "integer",
              "format": "int32",
              "description": "ID of return address to use"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "When to send letter (0/null=now)"
            }
          },
          "required": [
            "address_city",
            "address_country",
            "address_line_1",
            "address_name",
            "address_postal_code",
            "address_state",
            "return_address_id"
          ]
        },
        "description": "Array of recipients"
      }
    },
    "required": [
      "PCID",
      "file_urls",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_return\_addresses\_by\_return\_address\_id\_delete

Delete specific post return address

**Parameters:**

| Parameter           | Type    | Required | Default | Description       |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `return_address_id` | integer | Yes      | —       | Return address ID |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "return_address_id": {
        "type": "integer",
        "description": "Return address ID"
      }
    },
    "required": [
      "PCID",
      "return_address_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_return\_addresses\_by\_return\_address\_id\_get

Get specific post return address

**Parameters:**

| Parameter           | Type    | Required | Default | Description       |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `return_address_id` | integer | Yes      | —       | Return address ID |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "return_address_id": {
        "type": "integer",
        "description": "Return address ID"
      }
    },
    "required": [
      "PCID",
      "return_address_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_return\_addresses\_by\_return\_address\_id\_put

Update post return address

**Parameters:**

| Parameter             | Type    | Required | Default | Description         |
| --------------------- | ------- | -------- | ------- | ------------------- |
| `return_address_id`   | integer | Yes      | —       | Return address ID   |
| `address_city`        | string  | Yes      | —       | Your city           |
| `address_country`     | string  | Yes      | —       | Your country        |
| `address_line_1`      | string  | Yes      | —       | Your address line 1 |
| `address_line_2`      | string  | No       | —       | Your address line 2 |
| `address_name`        | string  | Yes      | —       | Your address name.  |
| `address_postal_code` | string  | Yes      | —       | Your postal code    |
| `address_state`       | string  | No       | —       | Your state          |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "return_address_id": {
        "type": "integer",
        "description": "Return address ID"
      },
      "address_city": {
        "type": "string",
        "description": "Your city"
      },
      "address_country": {
        "type": "string",
        "description": "Your country"
      },
      "address_line_1": {
        "type": "string",
        "description": "Your address line 1"
      },
      "address_line_2": {
        "type": "string",
        "description": "Your address line 2"
      },
      "address_name": {
        "type": "string",
        "description": "Your address name."
      },
      "address_postal_code": {
        "type": "string",
        "description": "Your postal code"
      },
      "address_state": {
        "type": "string",
        "description": "Your state"
      }
    },
    "required": [
      "PCID",
      "return_address_id",
      "address_city",
      "address_country",
      "address_line_1",
      "address_name",
      "address_postal_code"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_return\_addresses\_get

Get list of post return addresses

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_post\_return\_addresses\_post

Create post return address

**Parameters:**

| Parameter             | Type   | Required | Default | Description         |
| --------------------- | ------ | -------- | ------- | ------------------- |
| `address_city`        | string | Yes      | —       | Your city           |
| `address_country`     | string | Yes      | —       | Your country        |
| `address_line_1`      | string | Yes      | —       | Your address line 1 |
| `address_line_2`      | string | No       | —       | Your address line 2 |
| `address_name`        | string | Yes      | —       | Your address name.  |
| `address_postal_code` | string | Yes      | —       | Your postal code    |
| `address_state`       | string | No       | —       | Your state          |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "address_city": {
        "type": "string",
        "description": "Your city"
      },
      "address_country": {
        "type": "string",
        "description": "Your country"
      },
      "address_line_1": {
        "type": "string",
        "description": "Your address line 1"
      },
      "address_line_2": {
        "type": "string",
        "description": "Your address line 2"
      },
      "address_name": {
        "type": "string",
        "description": "Your address name."
      },
      "address_postal_code": {
        "type": "string",
        "description": "Your postal code"
      },
      "address_state": {
        "type": "string",
        "description": "Your state"
      }
    },
    "required": [
      "PCID",
      "address_city",
      "address_country",
      "address_line_1",
      "address_name",
      "address_postal_code"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_price\_post

Calculate Total Price for Fax Messages sent

**Parameters:**

| Parameter  | Type      | Required | Default | Description               |
| ---------- | --------- | -------- | ------- | ------------------------- |
| `file_url` | string    | Yes      | —       | URL of file to send       |
| `messages` | object\[] | Yes      | —       | Array of FaxMessage items |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "file_url": {
        "type": "string",
        "description": "URL of file to send"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string",
              "description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
            },
            "to": {
              "type": "string",
              "description": "Recipient fax number in E.164 format."
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
            },
            "from": {
              "type": "string",
              "description": "Your sender id. Must be a valid fax number."
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
            },
            "custom_string": {
              "type": "string",
              "description": "Your reference. Will be passed back with all replies and delivery reports."
            },
            "country": {
              "type": "string",
              "description": "Recipient country."
            },
            "from_email": {
              "type": "string",
              "description": "An email address where the reply should be emailed to."
            }
          },
          "required": [
            "to"
          ]
        },
        "description": "Array of FaxMessage items"
      }
    },
    "required": [
      "PCID",
      "file_url",
      "messages"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_receipts\_by\_message\_id\_get

Get a single fax receipt based on message id.

**Parameters:**

| Parameter    | Type   | Required | Default | Description                           |
| ------------ | ------ | -------- | ------- | ------------------------------------- |
| `message_id` | string | Yes      | —       | ID of the message receipt to retrieve |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "message_id": {
        "type": "string",
        "description": "ID of the message receipt to retrieve"
      }
    },
    "required": [
      "PCID",
      "message_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_receipts\_get

Get all delivery receipts

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_receipts\_post

Add a delivery receipt

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `url`     | string | Yes      | —       | Your url.   |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "url": {
        "type": "string",
        "description": "Your url."
      }
    },
    "required": [
      "PCID",
      "url"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_receipts\_read\_put

Mark delivery receipts as read

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                        |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `date_before` | number | No       | —       | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "date_before": {
        "type": "number",
        "description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_fax\_post\_send\_post

Send a fax using supplied supported file-types.

**Parameters:**

| Parameter  | Type      | Required | Default | Description               |
| ---------- | --------- | -------- | ------- | ------------------------- |
| `file_url` | string    | Yes      | —       | URL of file to send       |
| `messages` | object\[] | Yes      | —       | Array of FaxMessage items |

<Expandable title="inputSchema">
  ```json  theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "file_url": {
        "type": "string",
        "description": "URL of file to send"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string",
              "description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
            },
            "to": {
              "type": "string",
              "description": "Recipient fax number in E.164 format."
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
            },
            "from": {
              "type": "string",
              "description": "Your sender id. Must be a valid fax number."
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
            },
            "custom_string": {
              "type": "string",
              "description": "Your reference. Will be passed back with all replies and delivery reports."
            },
            "country": {
              "type": "string",
              "description": "Recipient country."
            },
            "from_email": {
              "type": "string",
              "description": "An email address where the reply should be emailed to."
            }
          },
          "required": [
            "to"
          ]
        },
        "description": "Array of FaxMessage items"
      }
    },
    "required": [
      "PCID",
      "file_url",
      "messages"
    ]
  }
  ```
</Expandable>