Update Default Fax Settings
curl --request PUT \
--url https://api.mintfax.com/v1/environment/fax-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>"
}
'import requests
url = "https://api.mintfax.com/v1/environment/fax-settings"
payload = {
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhook_url: '<string>', max_attempts: 3, csid: '<string>'})
};
fetch('https://api.mintfax.com/v1/environment/fax-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintfax.com/v1/environment/fax-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'webhook_url' => '<string>',
'max_attempts' => 3,
'csid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mintfax.com/v1/environment/fax-settings"
payload := strings.NewReader("{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.mintfax.com/v1/environment/fax-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintfax.com/v1/environment/fax-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>",
"page_size": "letter",
"resolution": "standard",
"optimize_for": "text"
}Environment
Update Default Fax Settings
Set default fax submission parameters for the environment. These apply to all
faxes unless overridden per submission.
Requires an environment key (mfx_test_... or mfx_live_...).
PUT
/
environment
/
fax-settings
Update Default Fax Settings
curl --request PUT \
--url https://api.mintfax.com/v1/environment/fax-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>"
}
'import requests
url = "https://api.mintfax.com/v1/environment/fax-settings"
payload = {
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhook_url: '<string>', max_attempts: 3, csid: '<string>'})
};
fetch('https://api.mintfax.com/v1/environment/fax-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintfax.com/v1/environment/fax-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'webhook_url' => '<string>',
'max_attempts' => 3,
'csid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mintfax.com/v1/environment/fax-settings"
payload := strings.NewReader("{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.mintfax.com/v1/environment/fax-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintfax.com/v1/environment/fax-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"<string>\",\n \"max_attempts\": 3,\n \"csid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"webhook_url": "<string>",
"max_attempts": 3,
"csid": "<string>",
"page_size": "letter",
"resolution": "standard",
"optimize_for": "text"
}Authorizations
API key as Bearer token. Use an account key (mfx_acct_...) for
/account/* endpoints, and an environment key (mfx_test_... for
sandbox, mfx_live_... for live) for /environment/*, /faxes,
/webhooks, and /events.
Body
application/json
Maximum string length:
2048Required range:
1 <= x <= 5Maximum string length:
20Available options:
letter, legal, a4, b4 Available options:
standard, fine Available options:
text, photo Response
FaxSettingsResource
Default per-fax webhook URL override.
Default attempt cap for faxes (1-5). See ADR-021.
Example:
3
Default CSID for outbound faxes (max 20 chars).
Default page size for rendered content. PDF inputs pass through unchanged.
Available options:
letter, legal, a4, b4 Default T.30 transmission resolution.
Available options:
standard, fine Default rasterizer optimization hint for non-PDF inputs.
Available options:
text, photo Last modified on July 30, 2026