Dropbox Sign Developer Documentation

import json
from datetime import date, datetime
from pprint import pprint
from dropbox_sign import ApiClient, ApiException, Configuration, api, models
configuration = Configuration(
    username="YOUR_API_KEY",
)
with ApiClient(configuration) as api_client:
    fax_send_request = models.FaxSendRequest(
        recipient="16690000001",
        sender="16690000000",
        test_mode=True,
        cover_page_to="Jill Fax",
        cover_page_from="Faxer Faxerson",
        cover_page_message="I'm sending you a fax!",
        title="This is what the fax is about!",
        files=[
            open("./example_fax.pdf", "rb").read(),
        ],
    )
    try:
        response = api.FaxApi(api_client).fax_send(
            fax_send_request=fax_send_request,
        )
        pprint(response)
    except ApiException as e:
        print("Exception when calling FaxApi#fax_send: %s\n" % e)

{
  "fax": {
    "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d",
    "title": "example title",
    "original_title": "example original title",
    "metadata": [],
    "created_at": 1726774555,
    "sender": "me@dropboxsign.com",
    "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2",
    "transmissions": [
      {
        "recipient": "recipient@dropboxsign.com",
        "status_code": "success",
        "sent_at": 1723231831
      }
    ],
    "subject": "example subject",
    "message": "example message"
  }
}

Creates and sends a new Fax with the submitted file(s)

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

recipientstringRequired

Recipient of the fax Can be a phone number in E.164 format or email address

senderstringOptional

Fax Send From Sender (used only with fax number)

fileslist of stringsOptional

Use files[] to indicate the uploaded file(s) to fax

This endpoint requires either files or file_urls[], but not both.

file_urlslist of stringsOptional

Use file_urls[] to have Dropbox Fax download the file(s) to fax

This endpoint requires either files or file_urls[], but not both.

test_modebooleanOptionalDefaults to false

API Test Mode Setting

cover_page_tostringOptional

Fax cover page recipient information

cover_page_fromstringOptional

Fax cover page sender information

cover_page_messagestringOptional

Fax Cover Page Message

titlestringOptional

Fax Title

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

faxobject

warningslist of objects or null

A list of warnings.

Send Fax

Authentication

Request

Response headers

Response

Errors