Send a fax to one or more recipients using multipart/form-data. Include a required JSON metadata part and, when needed, one or more files parts. Each fax must include at least one document, a valid cover page, or both. A request can contain up to 20 files with a combined size of 100 MB. Use GET /v1/cover-pages to find available cover page names and their required fields.

One fax is attempted for each recipient. The 202 Accepted response contains a result for every recipient in request order. The overall outcome is succeeded, partial, or failed; check each item in fax_ids for its status, fax_id, or error details.

Example 1: Send documents without a cover page

Add one or more document parts named files and use this JSON for the metadata part:

{
  "metadata": {
    "recipients": [{
      "name": "Example Insurance Company",
      "company": "Example Insurance Company",
      "fax_number": "+12025550164"
    }]
  }
}

Example 2: Send a cover page with documents

Add one or more document parts named files and use this JSON for the metadata part:

{
  "metadata": {
    "originating_fax_number": "+12025550123",
    "recipients": [{
      "name": "Dr. Jane Example",
      "company": "Example Health Clinic",
      "fax_number": "+12025550164"
    }]
  },
  "cover_page": {
    "name": "Default",
    "fields": {
      "to-name": "Dr. Jane Example",
      "from-name": "Records Department",
      "fax-back-number": "+12025550123",
      "from-company": "Example Healthcare Organization",
      "subject": "Example records",
      "message": "Please confirm receipt."
    }
  }
}

Example 3: Send a cover-page-only fax

Do not add a files part. Use this JSON for the metadata part:

{
  "metadata": {
    "recipients": [{
      "name": "Dr. Jane Example",
      "fax_number": "+12025550164"
    }]
  },
  "cover_page": {
    "name": "Default",
    "fields": {
      "to-name": "Dr. Jane Example",
      "from-name": "Records Department",
      "fax-back-number": "+12025550123",
      "message": "Cover-page-only notification."
    }
  }
}

Example 4: Send documents to multiple recipients

Add one or more document parts named files. Every recipient receives the same document set, and the response contains a separate result for each recipient. Use this JSON for the metadata part:

{
  "metadata": {
    "recipients": [
      {
        "name": "Example Insurance Company",
        "company": "Example Insurance Company",
        "fax_number": "+12025550164"
      },
      {
        "name": "Dr. Jane Example",
        "company": "Example Health Clinic",
        "fax_number": "+12025550165"
      }
    ]
  }
}