Create a fax

Updated: November 6, 2026

POST/uc/{connection_id}/fax

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

Parameters

Payload

A fax sent or received through a phone number

idstring

Unique identifier for this fax object

created_atdate-time

The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type enum

Valid values:

"INBOUND"

"OUTBOUND"

Whether the fax was received (INBOUND) or sent (OUTBOUND)

status enum

Valid values:

"QUEUED"

"SENDING"

"DELIVERED"

"RECEIVING"

"RECEIVED"

"FAILED"

"CANCELED"

"OTHER"

The current or final status of the fax

from_telephonestring

The E.164 phone number the fax was sent from

to_telephonestring

The E.164 phone number the fax was sent to

pagesnumber

Number of pages in the fax

media_urlstring

URL of the fax document (PDF); on create, a public URL of the document to send

user_idstring

The user that sent or owns the fax (reference to HrisEmployee)

cost_amountnumber

What the integration charged for the fax

currencystring

ISO 4217 currency of cost_amount

error_messagestring

Why the fax failed

metadata array

raw

The raw data returned by the integration for this fax

Returns

UcFax

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

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'POST',
  url: 'https://api.unified.to/uc/5de520f96e439b002043d8dc/fax',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.uc.createUcFax({ connectionId, ucFax: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'POST',
  url: 'https://api.unified.to/uc/5de520f96e439b002043d8dc/fax',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("POST", "https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw=

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request POST \
  --url 'https://api.unified.to/uc/5de520f96e439b002043d8dc/fax?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?