Skip to main content
Server path: /dropbox-sign-fax | Type: Application | PCID required: Yes

​
Tools

ToolDescription
dropbox_sign_fax_deleteDelete Fax
dropbox_sign_fax_filesDownload Fax Files
dropbox_sign_fax_getGet Fax
dropbox_sign_fax_line_add_userAdd Fax Line User
dropbox_sign_fax_line_area_code_getGet Available Fax Line Area Codes
dropbox_sign_fax_line_createPurchase Fax Line
dropbox_sign_fax_line_deleteDelete Fax Line
dropbox_sign_fax_line_getGet Fax Line
dropbox_sign_fax_line_listList Fax Lines
dropbox_sign_fax_line_remove_userRemove Fax Line Access
dropbox_sign_fax_listLists Faxes
dropbox_sign_fax_sendSend Fax

​
dropbox_sign_fax_delete

Delete Fax Parameters:
ParameterTypeRequiredDefaultDescription
fax_idstringYes—Fax ID

​
dropbox_sign_fax_files

Download Fax Files Parameters:
ParameterTypeRequiredDefaultDescription
fax_idstringYes—Fax ID

​
dropbox_sign_fax_get

Get Fax Parameters:
ParameterTypeRequiredDefaultDescription
fax_idstringYes—Fax ID

​
dropbox_sign_fax_line_add_user

Add Fax Line User Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Account ID
email_addressstringNo—Email address
numberstringYes—The Fax Line number

​
dropbox_sign_fax_line_area_code_get

Get Available Fax Line Area Codes Parameters:
ParameterTypeRequiredDefaultDescription
countrystringYes—Filter area codes by country
statestringNo—Filter area codes by state
provincestringNo—Filter area codes by province
citystringNo—Filter area codes by city

​
dropbox_sign_fax_line_create

Purchase Fax Line Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Account ID of the account that will be assigned this new Fax Line
area_codeintegerYes—Area code of the new Fax Line
citystringNo—City of the area code
countrystringYes—Country of the area code

​
dropbox_sign_fax_line_delete

Delete Fax Line Parameters:
ParameterTypeRequiredDefaultDescription
numberstringYes—The Fax Line number

​
dropbox_sign_fax_line_get

Get Fax Line Parameters:
ParameterTypeRequiredDefaultDescription
numberstringYes—The Fax Line number

​
dropbox_sign_fax_line_list

List Fax Lines Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Account ID
pageintegerNo—Which page number of the Fax Line List to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.
show_team_linesbooleanNo—Include Fax Lines belonging to team members in the list

​
dropbox_sign_fax_line_remove_user

Remove Fax Line Access Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNo—Account ID of the user to remove access
email_addressstringNo—Email address of the user to remove access
numberstringYes—The Fax Line number

​
dropbox_sign_fax_list

Lists Faxes Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNo—Which page number of the Fax List to return. Defaults to 1.
page_sizeintegerNo—Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

​
dropbox_sign_fax_send

Send Fax Parameters:
ParameterTypeRequiredDefaultDescription
cover_page_fromstringNo—Fax cover page sender information
cover_page_messagestringNo—Fax Cover Page Message
cover_page_tostringNo—Fax cover page recipient information
file_urlsstring[]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.
filesstring[]No—Use files[] to indicate the uploaded file(s) to fax This endpoint requires either files or file_urls[], but not both.
recipientstringYes—Recipient of the fax Can be a phone number in E.164 format or email address
senderstringNo—Fax Send From Sender (used only with fax number)
test_modebooleanNo—API Test Mode Setting
titlestringNo—Fax Title