Create a fax server

Creates a virtual fax line: a fax extension is allocated, the number in caller_id_number is pointed at it, inbound routing for that number is created or updated, and the users in users and emails_to_fax are given access. Each fax server uses one fax license, and the request is refused with 403 when none are left. The steps run one after another without a transaction, so a failure part-way leaves the earlier steps applied. Success is 200 rather than 201, and this requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Outbound caller-ID name. Control characters are stripped and the length is capped.

string
required

Number used as the fax server's caller ID. An existing route for this number on your account is repointed at the fax server, and the number's inbound routing is created or updated.

string | null
required

Address that receives notifications for this fax line; may be null.

string
required

Free-text description. Control characters are stripped and the length is capped.

users
array of strings
required

Ids of the users assigned to this fax server. Required — omitting it fails with 500.

users*
string | null

How many days to keep faxes, as a numeric string. null, "", "forever" or anything unparsable means keep them indefinitely.

string

Logo shown on generated coversheets.

emails_to_fax
array of strings

Ids of the users allowed to submit faxes by email.

emails_to_fax
Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json