Update a fax server

patch

https://api.emaktalk.com/api/v1/fax/servers/{serverId}

Changes a fax server, one of two ways chosen by update_type:

logo: changes only the coversheet logo.
editServer: replaces its settings. caller_id_name, description, users and emails_to_fax are replaced by what you send, so omitting one clears it; email, lifecycle and fax_ai_subject keep their values when omitted. Read the fax server first and send everything back.

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

Effect of a new caller_id_number: the fax server moves to the new number's inbound routing (created when the number has none) and the old number is released. Both changes show in the numbers' history.

Response: 200 { "success": true }.

Notes: the steps of editServer run one after another. A failure part-way leaves the earlier steps in place: read the fax server and send the edit again.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serverId

uuid

required

The fax server's fax_uuid.

Body Params

Replaces the fax server's settings. caller_id_name, description, users and emails_to_fax are replaced by what you send, and omitting one clears it. email, lifecycle and fax_ai_subject keep their values when omitted.

update_type

string

enum

required

Allowed:

caller_id_number

string

required

The number it sends from and receives on (digits, optionally led by +). Changing it moves the fax server to the new number's inbound routing and releases the old number.

caller_id_name

string

The fax server's name. Omitted, it becomes empty.

description

string

Omitted, it becomes empty.

string | null

null clears it; omitted, it is kept.

users

array of uuids

The complete list of assigned users. Omitted or [], nobody stays assigned.

users

emails_to_fax

array of uuids

The complete email-to-fax list. Omitted or [], it is cleared.

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.

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 updated.

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.

403 Unauthorized Access Unable to Update Fax Server!: the key is Scoped. Unauthorized Access The phone number supplied is routed by another account! Unauthorized Access One of the selected users does not belong to this account. Forbidden Logo not available to this fax server.

404Not Found Fax Server not found!

409Conflict The fax server's logo changed meanwhile. Reload and try again.

500Server Error Unable to Update Fax Server!: the logo could not be changed; retry.

503Service Unavailable Unable to read the fax server's account. Please try again.; or your key could not be checked (wait Retry-After seconds).