Create a new fax server

This API allows authorized users to create a new fax server. The necessary data is provided in the request body, including caller ID information, email configuration, user associations, and optional settings. The newly created fax server will be configured according to the provided details.

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

Headers:

Authorization: Bearer [Token]

Body:

KeyDescriptionRequired
caller_id_numberThe Phone Number to Display as Caller IDYes
caller_id_nameThe Name to Display as the Caller IDYes
emailComma Separated Emails to be Notified When Using this Fax ServerNo
descriptionA Brief Description of the Fax ServerYes
usersAn array of Users' UUID associated with the fax serverYes
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 Cloudflareno
Body Params
string
required

The Phone Number to Display as Caller ID

string
required

The Name to Display as the Caller ID

string

The Emails to be Notified When Using this Fax Server

string
required

A Brief Description of the Fax Server

users
array of uuids

An array of users' UUID associated with the fax server

users
string

The Lifecycle Setting for the Fax Server (Retention Policy)

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

The Uploaded Logo Public URL to Cloudflare

Responses

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