FxFaximus Developers
Production APIPortal

Email Fax

Use the Faximus API to manage email fax domains and recipients and review verification requirements.

StartAuthenticationDocumentsFax JobsInboxEmail FaxWebhooksErrorsOpenAPI

Reference

Email Fax

GET/v1/email-fax/settingsRead fax email settingsRead fax-to-email preferences, accepted email-to-fax domains, verified source domains, optional sending fax number defaults, verified recipients, and recent email-to-fax activity.fax:read

Read fax-to-email preferences, accepted email-to-fax domains, verified source domains, optional sending fax number defaults, verified recipients, and recent email-to-fax activity.

Required scope
fax:read
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
getEmailFaxSettings
Response example
{
  "acceptedEmailToFaxDomains": ["faxim.us"],
  "preferences": {
    "faxToEmail": { "deliveryMode": "attach_pdf" },
    "emailToFax": { "enabled": true }
  },
  "sourceDomains": [
    { "domainId": "77777777-7777-4777-8777-777777777777", "domainName": "example.com", "verificationStatus": "verified" }
  ],
  "recipients": [
    { "recipientId": "88888888-8888-4888-8888-888888888888", "email": "records@example.com", "recipientStatus": "verified" }
  ],
  "activity": [
    {
      "direction": "email_to_fax",
      "messageStatus": "accepted",
      "requestId": "req_01JZ8Z0V6R2WHD1RCKE4FZ8N9A"
    }
  ]
}
PATCH/v1/email-fax/settingsUpdate fax email preferencesChoose fax-to-email delivery mode, enable email-to-fax, and optionally set account, domain, or exact source-email sending fax number defaults. Unconfigured email-to-fax selects an eligible sender automatically.admin:tenant

Choose fax-to-email delivery mode, enable email-to-fax, and optionally set account, domain, or exact source-email sending fax number defaults. Unconfigured email-to-fax selects an eligible sender automatically.

Required scope
admin:tenant
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
patchEmailFaxSettings
Response example
{ "preferences": { "faxToEmail": { "deliveryMode": "attach_pdf" }, "emailToFax": { "enabled": true } } }
GET/v1/email-fax/messagesList email fax activityRead customer-safe gateway attempts. Defaults to email-to-fax requests sent to <destinationDigits>@faxim.us; pass direction=fax_to_email to read fax-to-email delivery notifications.fax:read

Read customer-safe gateway attempts. Defaults to email-to-fax requests sent to <destinationDigits>@faxim.us; pass direction=fax_to_email to read fax-to-email delivery notifications.

Required scope
fax:read
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
listEmailFaxMessages
Response example
{ "items": [{ "direction": "email_to_fax", "messageStatus": "rejected", "rejectionCode": "configured_sender_unavailable" }] }
POST/v1/email-fax/domainsRequest a source domainRegister and DNS-verify a sender domain. Any verified mailbox on a verified source domain can send to <destinationDigits>@faxim.us.admin:tenant

Register and DNS-verify a sender domain. Any verified mailbox on a verified source domain can send to <destinationDigits>@faxim.us.

Required scope
admin:tenant
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
createEmailFaxDomain
Response example
{ "sourceDomain": { "domainId": "77777777-7777-4777-8777-777777777777", "domainName": "example.com", "verificationStatus": "pending", "verificationRecordName": "_faximus.example.com" } }
POST/v1/email-fax/domains/{domainId}/verifyVerify a source domainChecks the required TXT record and marks a source domain verified when DNS is correct.admin:tenant

Checks the required TXT record and marks a source domain verified when DNS is correct.

Required scope
admin:tenant
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
verifyEmailFaxDomain
Response example
{ "sourceDomain": { "domainId": "77777777-7777-4777-8777-777777777777", "domainName": "example.com", "verificationStatus": "verified" } }
POST/v1/email-fax/recipientsRequest a recipient emailRegister and verify a destination email address before fax-to-email delivery can target it.admin:tenant

Register and verify a destination email address before fax-to-email delivery can target it.

Required scope
admin:tenant
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
createEmailFaxRecipient
Response example
{ "recipient": { "recipientId": "88888888-8888-4888-8888-888888888888", "email": "records@example.com", "recipientStatus": "pending" } }