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

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>"
}
'

200

Example

{
  "webhook_url": "<string>",
  "max_attempts": 123,
  "csid": "<string>"
}

Authorizations

Authorization · string · header · required

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

webhook_url · string<uri> | null

Maximum string length: 2048

max_attempts · integer | null

Required range: 1 <= x <= 5

csid · string | null

Maximum string length: 20

page_size · enum<string> | null

Available options: letter, legal, a4, b4

resolution · enum<string> | null

Available options: standard, fine

optimize_for · enum<string> | null

Available options: text, photo

Response

200

application/json

FaxSettingsResource

webhook_url · string<uri> | null · required

Default per-fax webhook URL override.

max_attempts · integer · required

Default attempt cap for faxes (1-5). See ADR-021.

Example:

3

csid · string | null · required

Default CSID for outbound faxes (max 20 chars).

page_size · enum<string> | null · required

Default page size for rendered content. PDF inputs pass through unchanged.

Available options: letter, legal, a4, b4

resolution · enum<string> | null · required

Default T.30 transmission resolution.

Available options: standard, fine

optimize_for · enum<string> | null · required

Default rasterizer optimization hint for non-PDF inputs.

Available options: text, photo