> ## 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.
# dropbox-sign-fax
> Dropbox Sign Fax - send and manage faxes and fax lines
**Server path:** `/dropbox-sign-fax` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------- | --------------------------------- |
| [`dropbox_sign_fax_delete`](#dropbox_sign_fax_delete) | Delete Fax |
| [`dropbox_sign_fax_files`](#dropbox_sign_fax_files) | Download Fax Files |
| [`dropbox_sign_fax_get`](#dropbox_sign_fax_get) | Get Fax |
| [`dropbox_sign_fax_line_add_user`](#dropbox_sign_fax_line_add_user) | Add Fax Line User |
| [`dropbox_sign_fax_line_area_code_get`](#dropbox_sign_fax_line_area_code_get) | Get Available Fax Line Area Codes |
| [`dropbox_sign_fax_line_create`](#dropbox_sign_fax_line_create) | Purchase Fax Line |
| [`dropbox_sign_fax_line_delete`](#dropbox_sign_fax_line_delete) | Delete Fax Line |
| [`dropbox_sign_fax_line_get`](#dropbox_sign_fax_line_get) | Get Fax Line |
| [`dropbox_sign_fax_line_list`](#dropbox_sign_fax_line_list) | List Fax Lines |
| [`dropbox_sign_fax_line_remove_user`](#dropbox_sign_fax_line_remove_user) | Remove Fax Line Access |
| [`dropbox_sign_fax_list`](#dropbox_sign_fax_list) | Lists Faxes |
| [`dropbox_sign_fax_send`](#dropbox_sign_fax_send) | Send Fax |
***
## dropbox\_sign\_fax\_delete
Delete Fax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `fax_id` | string | Yes | — | Fax ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fax_id": {
"type": "string",
"description": "Fax ID"
}
},
"required": [
"PCID",
"fax_id"
]
}
```
***
## dropbox\_sign\_fax\_files
Download Fax Files
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `fax_id` | string | Yes | — | Fax ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fax_id": {
"type": "string",
"description": "Fax ID"
}
},
"required": [
"PCID",
"fax_id"
]
}
```
***
## dropbox\_sign\_fax\_get
Get Fax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `fax_id` | string | Yes | — | Fax ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fax_id": {
"type": "string",
"description": "Fax ID"
}
},
"required": [
"PCID",
"fax_id"
]
}
```
***
## dropbox\_sign\_fax\_line\_add\_user
Add Fax Line User
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------- |
| `account_id` | string | No | — | Account ID |
| `email_address` | string | No | — | Email address |
| `number` | string | Yes | — | The Fax Line number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Account ID"
},
"email_address": {
"type": "string",
"description": "Email address"
},
"number": {
"type": "string",
"description": "The Fax Line number"
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dropbox\_sign\_fax\_line\_area\_code\_get
Get Available Fax Line Area Codes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------------------- |
| `country` | string | Yes | — | Filter area codes by country |
| `state` | string | No | — | Filter area codes by state |
| `province` | string | No | — | Filter area codes by province |
| `city` | string | No | — | Filter area codes by city |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"country": {
"type": "string",
"description": "Filter area codes by country",
"enum": [
"CA",
"US",
"UK"
]
},
"state": {
"type": "string",
"description": "Filter area codes by state",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY"
]
},
"province": {
"type": "string",
"description": "Filter area codes by province",
"enum": [
"AB",
"BC",
"MB",
"NB",
"NL",
"NT",
"NS",
"NU",
"ON",
"PE",
"QC",
"SK",
"YT"
]
},
"city": {
"type": "string",
"description": "Filter area codes by city"
}
},
"required": [
"PCID",
"country"
]
}
```
***
## dropbox\_sign\_fax\_line\_create
Purchase Fax Line
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------------------------------------------------------- |
| `account_id` | string | No | — | Account ID of the account that will be assigned this new Fax Line |
| `area_code` | integer | Yes | — | Area code of the new Fax Line |
| `city` | string | No | — | City of the area code |
| `country` | string | Yes | — | Country of the area code |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Account ID of the account that will be assigned this new Fax Line"
},
"area_code": {
"type": "integer",
"description": "Area code of the new Fax Line"
},
"city": {
"type": "string",
"description": "City of the area code"
},
"country": {
"type": "string",
"description": "Country of the area code",
"enum": [
"CA",
"US",
"UK"
]
}
},
"required": [
"PCID",
"area_code",
"country"
]
}
```
***
## dropbox\_sign\_fax\_line\_delete
Delete Fax Line
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `number` | string | Yes | — | The Fax Line number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "The Fax Line number"
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dropbox\_sign\_fax\_line\_get
Get Fax Line
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `number` | string | Yes | — | The Fax Line number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "The Fax Line number"
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dropbox\_sign\_fax\_line\_list
List Fax Lines
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `account_id` | string | No | — | Account ID |
| `page` | integer | No | — | Which page number of the Fax Line List to return. Defaults to `1`. |
| `page_size` | integer | No | — | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. |
| `show_team_lines` | boolean | No | — | Include Fax Lines belonging to team members in the list |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Account ID"
},
"page": {
"type": "integer",
"description": "Which page number of the Fax Line List to return. Defaults to `1`."
},
"page_size": {
"type": "integer",
"description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
},
"show_team_lines": {
"type": "boolean",
"description": "Include Fax Lines belonging to team members in the list"
}
},
"required": [
"PCID"
]
}
```
***
## dropbox\_sign\_fax\_line\_remove\_user
Remove Fax Line Access
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------ |
| `account_id` | string | No | — | Account ID of the user to remove access |
| `email_address` | string | No | — | Email address of the user to remove access |
| `number` | string | Yes | — | The Fax Line number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Account ID of the user to remove access"
},
"email_address": {
"type": "string",
"description": "Email address of the user to remove access"
},
"number": {
"type": "string",
"description": "The Fax Line number"
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dropbox\_sign\_fax\_list
Lists Faxes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `page` | integer | No | — | Which page number of the Fax List to return. Defaults to `1`. |
| `page_size` | integer | No | — | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Which page number of the Fax List to return. Defaults to `1`."
},
"page_size": {
"type": "integer",
"description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
}
},
"required": [
"PCID"
]
}
```
***
## dropbox\_sign\_fax\_send
Send Fax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `cover_page_from` | string | No | — | Fax cover page sender information |
| `cover_page_message` | string | No | — | Fax Cover Page Message |
| `cover_page_to` | string | No | — | Fax cover page recipient information |
| `file_urls` | string\[] | No | — | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file\_urls\[]**, but not both. |
| `files` | string\[] | No | — | Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file\_urls\[]**, but not both. |
| `recipient` | string | Yes | — | Recipient of the fax Can be a phone number in E.164 format or email address |
| `sender` | string | No | — | Fax Send From Sender (used only with fax number) |
| `test_mode` | boolean | No | — | API Test Mode Setting |
| `title` | string | No | — | Fax Title |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cover_page_from": {
"type": "string",
"description": "Fax cover page sender information"
},
"cover_page_message": {
"type": "string",
"description": "Fax Cover Page Message"
},
"cover_page_to": {
"type": "string",
"description": "Fax cover page recipient information"
},
"file_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both."
},
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both."
},
"recipient": {
"type": "string",
"description": "Recipient of the fax Can be a phone number in E.164 format or email address"
},
"sender": {
"type": "string",
"description": "Fax Send From Sender (used only with fax number)"
},
"test_mode": {
"type": "boolean",
"description": "API Test Mode Setting"
},
"title": {
"type": "string",
"description": "Fax Title"
}
},
"required": [
"PCID",
"recipient"
]
}
```