---
title: "Create a fax"
method: POST
path: "/uc/{connection_id}/fax"
tags: ["uc", "fax"]
---

# Create a fax

`POST /uc/{connection_id}/fax`

## Request

- Base URL: `https://api.unified.to`
- URL: `https://api.unified.to/uc/{connection_id}/fax`
- Auth: API key in header `authorization`
- TypeScript: <https://skmtc.dev/unified/apis/unified-to-api/docs/uc/:connection_id/fax/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a UcFax. Provide the unified UcFax fields in the request body; they are mapped to the provider's API. Returns the created UcFax.

## Path parameters

- `connection_id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- UcFax: A fax sent or received through a phone number
  - `id` string: Unique identifier for this fax object
  - `created_at` string, date-time: The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `type` 'INBOUND' | 'OUTBOUND': Whether the fax was received (INBOUND) or sent (OUTBOUND)
  - `status` 'QUEUED' | 'SENDING' | 'DELIVERED' | 'RECEIVING' | 'RECEIVED' | 'FAILED' | 'CANCELED' | 'OTHER': The current or final status of the fax
  - `from_telephone` string: The E.164 phone number the fax was sent from
  - `to_telephone` string: The E.164 phone number the fax was sent to
  - `pages` number: Number of pages in the fax
  - `media_url` string: URL of the fax document (PDF); on create, a public URL of the document to send
  - `user_id` string: The user that sent or owns the fax (reference to HrisEmployee)
  - `cost_amount` number: What the integration charged for the fax
  - `currency` string: ISO 4217 currency of cost_amount
  - `error_message` string: Why the fax failed
  - `metadata` UcMetadata[]
    - `id` string
    - `slug` string
    - `value` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
  - `raw` object: The raw data returned by the integration for this fax

## Response `200`

Successful

- UcFax: A fax sent or received through a phone number
  - `id` string: Unique identifier for this fax object
  - `created_at` string, date-time: The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `type` 'INBOUND' | 'OUTBOUND': Whether the fax was received (INBOUND) or sent (OUTBOUND)
  - `status` 'QUEUED' | 'SENDING' | 'DELIVERED' | 'RECEIVING' | 'RECEIVED' | 'FAILED' | 'CANCELED' | 'OTHER': The current or final status of the fax
  - `from_telephone` string: The E.164 phone number the fax was sent from
  - `to_telephone` string: The E.164 phone number the fax was sent to
  - `pages` number: Number of pages in the fax
  - `media_url` string: URL of the fax document (PDF); on create, a public URL of the document to send
  - `user_id` string: The user that sent or owns the fax (reference to HrisEmployee)
  - `cost_amount` number: What the integration charged for the fax
  - `currency` string: ISO 4217 currency of cost_amount
  - `error_message` string: Why the fax failed
  - `metadata` UcMetadata[]
    - `id` string
    - `slug` string
    - `value` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
  - `raw` object: The raw data returned by the integration for this fax

## Changes

- **2026-11-06** `122e36e8450a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/unified/apis/unified-to-api/changes/uc/:connection_id/fax/post.md)

---

[API](https://skmtc.dev/unified/apis/unified-to-api.md) - [All operations](https://skmtc.dev/unified/apis/unified-to-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api/revisions/09f7759c650c?raw)