Resend a Fax

Resubmits a previously failed or delivered fax using the original document. A new credit hold is placed. Returns the new fax record.

POST /faxes/{fax}/resend

Resend a Fax

cURL

curl --request POST \
  --url https://api.mintfax.com/v1/faxes/{fax}/resend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "webhook_url": "<string>",
  "max_attempts": 3
}
'

201

Example

{
  "id": "<string>",
  "to": "<string>",
  "tags": {},
  "created_at": "2023-11-07T05:31:56Z",
  "resent_from": "<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.

Headers

Idempotency-Key · string

Client-generated key for idempotent submission (recommended). Duplicate keys return the original response without re-processing. Keys expire after 24 hours.

Path Parameters

fax · string · required

The fax public id

Body

application/json

to · string | null

Pattern: ^\+[1-9]\d{1,14}$

webhook_url · string<uri> | null

Maximum string length: 2048

max_attempts · integer | null

Required range: 1 <= x <= 5

Response

201

application/json

FaxSubmissionResource

id · string · required

Unique fax identifier (fax_-prefixed).

Example:

"fax_8aZqRm4yT3vK7pNxJ2bH9c"

status · enum<string> · required

Initial fax status.

Available options: queued, submitted, in_progress, delivered, failed

Example:

"queued"

to · string | null · required

Destination fax number in E.164 format.

Example:

"[phone]"

tags · object · required

Echo of caller-supplied metadata. Empty serializes as {}.

Show child attributes

created_at · string<date-time> · required

UTC timestamp when the fax record was created.

resent_from · string

Original fax identifier when this submission is a resend; only present on resends.

Example:

"fax_8aZqRm4yT3vK7pNxJ2bH9c"