Update a fax server

update_type: "editServer" replaces the fax server wholesale instead of merging: the user assignments and the email-to-fax list are cleared and rebuilt from users and emails_to_fax, so leaving either one out removes everyone. Changing caller_id_number detaches the old number, attaches the new one, rewrites that number's inbound routing and records both changes in the numbers' histories. update_type: "logo" is the narrow alternative that touches only the coversheet logo. Requires an API key with the Admin role; the steps are not transactional, and an id that does not exist fails as a server error rather than a 404.

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

Id of the fax server to update.

Body Params
string
required

logo to change only the coversheet logo, or editServer for a full edit. Any other value is rejected.

string | null

New coversheet logo, used with update_type: "logo".

string

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

string

The phone number this fax server sends and receives on. It must be a number routed to your account — naming a number routed elsewhere returns 403.

string | null

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

string

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

users
array of strings

Ids of the users assigned to the fax server. This replaces the whole set, so omitting it removes every assigned user.

users
string | null

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

emails_to_fax
array of strings

Ids of the users allowed to submit faxes by email. This replaces the whole list, so omitting it clears it.

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