Create a fax server

post

https://api.emaktalk.com/api/v1/fax/servers

Creates a fax server on one of your numbers: it sends from that number, and faxes to it arrive on this fax server.

Who may call it: an API key with All permissions. A Scoped key is refused with 403.

Effect, step by step:

Each fax server uses one fax license of your subscription: with none left, it is refused with 403 License Limit Reached.
An internal extension is allocated to answer its faxes, and the number's inbound routing on your account is pointed at it (created when the number has none).
users are assigned to it and emails_to_fax may send faxes from it by email.

Response: 200 with the new fax server's fax_uuid.

Notes:

The steps run one after another. A failure part-way leaves the earlier steps in place: list your fax servers before trying again.
Send caller_id_name: a fax server without a name can't send faxes (400 Fax Server is Missing Required Fields!).
Coversheet logos are uploaded in the web app.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

caller_id_name

string

The fax server's name. Control characters are removed and it is cut at 200 characters.

caller_id_number

string

required

The number it sends from and receives on: digits only, optionally led by +, up to 15 digits. If the number has inbound routing on your account, that routing is pointed at the new fax server; otherwise it is created.

string | null

The address emailed when a sent fax is delivered or fails for good.

description

string

Free text. Control characters are removed and it is cut at 200 characters.

users

array of uuids

required

Users of your account to assign to it. Send [] for none.

users*

emails_to_fax

array of uuids

Users of your account who may send faxes from it by email.

emails_to_fax

lifecycle

string | null

Days to keep each fax's document, as a numeric string ("365"). null, "", "forever" or text that isn't a number keep documents indefinitely.

logo_url

string | null

A coversheet logo already uploaded for your account in the web app: the fax_logo_url of one of your fax servers. null or "" uses the default logo.

fax_ai_subject

string

enum

Whether an AI-written subject is added to the faxes this fax server sends and receives, in the fax's own language.

with_names: the subject may include the names the fax shows.
without_names: the subject is written without people's, patients' or organizations' names. This is best effort, not a guarantee.
off: no AI subject, and the fax document is never sent to the AI provider.

A subject you type on a sent fax always wins. A change applies only to faxes sent or received afterwards. Omitted when you create a fax server, it is with_names; omitted when you edit one, it keeps its value.

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The fax server was created.

401No usable API key: none sent, a key that doesn't exist or was revoked (a revoked key stops working within a minute), or two kinds of credentials at once.

500License Check Failed Unable to verify fax licenses. Please try again later.: nothing was created. Omitting users also fails with a 500, after the fax server was created.