Update fax server details

This API allows authorized users to update the details of an existing fax server identified by its unique serverId, which is provided as a path variable in the request URL. The API supports updating various aspects of the fax server, including its configuration, caller ID, email settings, associated users, and logo. The update type is specified to indicate whether the change is related to the logo or the server configuration.

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

Headers:

Authorization: Bearer [Token]

Update Types:

  • "logo": Used for Updating the Logo of the Fax Server Only
  • "editServer": Used for Updating the Fax Server Itself

Body:

FieldsDescriptionRequired
update_typeSpecifies the type of update. Can be either logo (to update the logo) or editServer (to update server settings)Yes
domain_uuidThe Unique Identifier of the Domain Associated with the Fax ServerYes
caller_id_numberThe Phone Number to Display the Caller IDNo
caller_id_nameThe Name to Display the Caller IDNo
emailComma Separated Emails that will be Notified when Using this Fax ServerNo
descriptionA Brief Description of the Fax ServerNo
usersArray of Users' UUID's that are associated with this Fax ServerNo
lifecycleThe Lifecycle Setting for the Fax Server (Retention Policy) [1-days, 7-days, 30-days, 90-days, 365-days]No
emails_to_faxAn Array of Users' UUID that are Allowed to Send Faxes Through Emails for this Fax ServerNo
logo_urlThe Uploaded Logo Public URL to CloudflareYes if update_type is logo
Path Params
uuid
required

UUID of the fax server to update.

Body Params
string
required

Specifies the type of update. Can be either logo (to update the logo) or editServer (to update server settings)

uuid

The Unique Identifier of the Domain Associated with the Fax Server

string

The Phone Number to Display the Caller ID

string

The Name to Display the Caller ID

string

Comma Separated Emails that will be Notified when Using this Fax Server

string

A Brief Description of the Fax Server

users
array of uuids

Array of Users' UUID's that are associated with this Fax Server

users
string

The Lifecycle Setting for the Fax Server (Retention Policy) [1-days, 7-days, 30-days, 90-days, 365-days]

emails_to_fax
array of uuids

An Array of Users' UUID that are Allowed to Send Faxes Through Emails for this Fax Server

emails_to_fax
string

Cloudflare public file key. Used only when update type is 'logo'.

Responses

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