Skip to main content
PUT
/
account
/
settings
cURL
curl -X PUT https://api.mintfax.com/v1/account/settings \
  -H "Authorization: Bearer fx_test_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"webhook_url": "https://acme.com/webhooks/mintfax", "webhook_events": ["fax.delivered", "fax.failed"]}'
{
  "webhook_url": "https://acme.com/webhooks/mintfax",
  "webhook_events": [
    "fax.submitted",
    "fax.delivered",
    "fax.failed"
  ],
  "retention_days": 30,
  "zero_footprint": false
}

Documentation Index

Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Sandbox keys (fx_test_...) route to the sandbox environment. Live keys (fx_live_...) route to production.

Body

application/json

Account-level settings

​
webhook_url
string<uri> | null

Default webhook URL for all fax events

Example:

"https://acme.com/webhooks/mintfax"

​
webhook_events
string[]

Event types to deliver to the webhook URL

Example:
[
  "fax.submitted",
  "fax.delivered",
  "fax.failed"
]
​
retention_days
integer | null

Days to retain fax data (null for account default)

Example:

30

​
zero_footprint
boolean

Delete fax data immediately after terminal state

Example:

false

Response

Settings updated

Account-level settings

​
webhook_url
string<uri> | null

Default webhook URL for all fax events

Example:

"https://acme.com/webhooks/mintfax"

​
webhook_events
string[]

Event types to deliver to the webhook URL

Example:
[
  "fax.submitted",
  "fax.delivered",
  "fax.failed"
]
​
retention_days
integer | null

Days to retain fax data (null for account default)

Example:

30

​
zero_footprint
boolean

Delete fax data immediately after terminal state

Example:

false