An Outbox is a collection of faxes that are in the process of being sent or have been sent recently. It serves as a management interface for outgoing faxes, allowing you to monitor their status and perform various actions.
You can reuse files from existing faxes without uploading them again. This is useful for:
Resending failed faxes: Quickly retry a fax that didn’t go through
Forwarding received faxes: Send a received fax to new recipients
Bulk operations: Send the same document to multiple recipients over time
Combining documents: Append additional files to an existing fax. When combining, uploaded files are sent first, followed by the file from the existing fax.
When you resend or forward a fax, you can customize all parameters including destination numbers, cover pages, and sending options.
To preserve the original quality when resending, set options.enhancement: false to prevent reprocessing the fax file.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fax.Plus API","colors":{"primary":"#0a69ff","light":"#0a69ff","dark":"#0a69ff"},"logo":{"light":"https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/logo/light.svg?fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=56dd58e11c610ad1e40f907dc8a01cec","dark":"https://mintlify.s3.us-west-1.amazonaws.com/alohi-faxplus/resources/logo/dark.svg"},"favicon":"https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/favicon.png?fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=14b81cf7821bedc6b40dff2b7ff42063","appearance":{"default":"light","strict":true},"navbar":{"links":[],"primary":{"type":"button","label":"Create an account","href":"https://app.fax.plus"}},"footer":{"socials":{"website":"https://www.alohi.com","linkedin":"https://www.linkedin.com/company/alohi"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Connect to Cursor","description":"Install MCP server on Cursor","icon":"/resources/logo/cursor.svg","href":"cursor://anysphere.cursor-deeplink/mcp/install?name=Fax.Plus%20API\u0026config=eyJuYW1lIjoiRmF4LlBsdXMgQVBJIiwidXJsIjoiaHR0cHM6Ly9tY3AuZmF4LnBsdXMvbWNwIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfUEVSU09OQUxfQUNDRVNTX1RPS0VOIn19"},{"title":"Connect to VS Code","description":"Install MCP server on VS Code","icon":"/resources/logo/vscode.svg","href":"vscode:mcp/install?%7B%22name%22%3A%22Fax.Plus%20API%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.fax.plus%2Fmcp%22%2C%22type%22%3A%22http%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20PERSONAL_ACCESS_TOKEN%22%7D%7D"}],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"graduation-cap","href":"https://help.alohi.com/hc/en-us"},{"anchor":"Release Notes","icon":"rss","href":"https://www.alohi.com/release-notes"},{"anchor":"Compliance \u0026 Security","icon":"shield-halved","href":"https://www.alohi.com/trust/compliance"},{"anchor":"Blog","icon":"newspaper","href":"https://www.alohi.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"alohi-faxplus","hasAudioNarration":false,"actualSubdomain":"alohi-faxplus","customDomains":["apidoc.fax.plus"],"gitSource":{"type":"github","owner":"alohihq","repo":"faxplus-apidoc","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6accf5aed28d1821b17f825f","collectionId":"a4021c35-677c-4d15-8cdb-f7100b7d3239","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6accf5aed28d1821b17f825f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad1cd14ac3903f7e130810a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":77},{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Fax AI","count":12},{"language":"default","tag":"Contacts","count":11},{"language":"default","tag":"Accounts","count":8},{"language":"default","tag":"Outbox","count":7},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Faxes","count":6},{"language":"default","tag":"Concepts","count":6},{"language":"default","tag":"Files","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"concepts/outbox","slug":"/concepts/outbox","pageMetadata":{"title":"Outbox","icon":"inbox","openapi-schema":"OutboxList","description":null,"href":"/concepts/outbox"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Frame,Heading,OptimizedImage,Tip}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Frame,{children:_jsx(OptimizedImage,{className:`mint-block`,src:`https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=9f4b9a25084ddcddf1a2f58a232da368`,alt:`Outbox`,\"data-og-width\":`733`,width:`733`,\"data-og-height\":`314`,height:`314`,\"data-path\":`resources/concepts/outbox.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=280\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=f6eef0ef953a434fc89afaa1b2020e45 280w, https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=560\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=062d706fc75ece54ceafdbc7cbe4a737 560w, https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=840\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=64782a809e5bb1554db8c07e005c5f4d 840w, https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=adcaa17e7449ec31eb1ba62ff5e8a1a8 1100w, https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=d8617ab1efda944aa8ea5452364a5341 1650w, https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/concepts/outbox.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=cde1c209482ea2e7e762928918cac37d 2500w`})}),`\n`,_jsx(Heading,{level:`2`,id:`definition`,children:`Definition`}),`\n`,_jsxs(_components.p,{children:[`An `,_jsx(_components.strong,{children:`Outbox`}),` is a collection of faxes that are in the process of being sent or have been sent recently. It serves as a management interface for outgoing faxes, allowing you to monitor their status and perform various actions.`]}),`\n`,_jsx(Heading,{level:`2`,id:`key-concepts`,children:`Key Concepts`}),`\n`,_jsx(Heading,{level:`3`,id:`fax-statuses-in-outbox`,children:`Fax Statuses in Outbox`}),`\n`,_jsx(_components.p,{children:`Faxes in the outbox can have various statuses, including:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`submitted`}),`: The fax has been submitted to the system`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`converting`}),`: The fax is being converted to the appropriate format for transmission`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`scheduled_for_sending`}),`: The fax is scheduled to be sent at a future time`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`sending`}),`: The fax is currently being transmitted`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`actions-on-outbox-faxes`,children:`Actions on Outbox Faxes`}),`\n`,_jsx(_components.p,{children:`The Outbox interface allows you to perform several actions on faxes:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Delete`}),`: To cancel the fax transmission`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Download`}),`: To retrieve a copy of the fax document`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Add note`}),`: To attach a note to the fax for reference`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Resend/Forward`}),`: To reuse the fax file for sending to new recipients`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`resending-and-forwarding-faxes`,children:`Resending and Forwarding Faxes`}),`\n`,_jsx(_components.p,{children:`You can reuse files from existing faxes without uploading them again. This is useful for:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Resending failed faxes`}),`: Quickly retry a fax that didn’t go through`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Forwarding received faxes`}),`: Send a received fax to new recipients`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Bulk operations`}),`: Send the same document to multiple recipients over time`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Combining documents`}),`: Append additional files to an existing fax. When combining, uploaded files are sent first, followed by the file from the existing fax.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`When you resend or forward a fax, you can customize all parameters including destination numbers, cover pages, and sending options.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`To preserve the original quality when resending, set `,_jsx(_components.code,{children:`options.enhancement: false`}),` to prevent reprocessing the fax file.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`monitoring-fax-progress`,children:`Monitoring Fax Progress`}),`\n`,_jsx(_components.p,{children:`The Outbox is your primary tool for monitoring the progress of sent faxes. You can:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`See which faxes are currently being sent`}),`\n`,_jsx(_components.li,{children:`Track the success of your fax transmissions`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`schema`,children:`Schema`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Outbox","icon":"inbox","openapi-schema":"OutboxList","description":null,"href":"/concepts/outbox"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Definition","slug":"definition","depth":2,"children":[]},{"title":"Key Concepts","slug":"key-concepts","depth":2,"children":[{"title":"Fax Statuses in Outbox","slug":"fax-statuses-in-outbox","depth":3,"children":[]},{"title":"Actions on Outbox Faxes","slug":"actions-on-outbox-faxes","depth":3,"children":[]},{"title":"Resending and Forwarding Faxes","slug":"resending-and-forwarding-faxes","depth":3,"children":[]},{"title":"Monitoring Fax Progress","slug":"monitoring-fax-progress","depth":3,"children":[]},{"title":"Schema","slug":"schema","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/alohi-faxplus/2cb5dfef0e2c35ed/intercom-settings.js","/_mintlify/custom/alohi-faxplus/3ab685073112e2d2/intercom.js"],"dynamicCss":".mint-block {\n display: block\n}","openApiReferenceData":{"schemaData":{"description":"List of the outgoing faxes","properties":{"records":{"items":{"description":"Model for the outbound fax stored in the outbox","type":"object","example":{"comment":{"tags":[],"text":""},"contact_name":"","designated_src":"","extra_info":{},"file_changes":[],"files":["/transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df"],"id":"13a4afb0585345639733857e8f36df8d","initiated_from":{"from_id":"","type":""},"ip":"8.8.8.8","last_updated_status_time":"2017-09-24 06:43:04","options":{},"page_count":0,"retry":{"count":0,"delay":0},"send_time":"2017-09-24 06:43:04 +0000","should_enhance":false,"src":"+16699990000","status":"submitted","status_changes":[{"at":"2017-09-24 06:43:04","status":"submitted"}],"submit_time":"2017-09-24 06:43:04 +0000","to":["+16699990000"],"uid":"53a1afb8585345a39033857e1f36bf8d"},"properties":{"id":{"description":"Fax ID","type":"string","isRequired":true,"uniqueKey":"records.items.[INDEX].id","typeLabel":"string"},"status":{"description":"Outbound fax status","type":"string","enum":["submitted","converting","scheduled_for_sending","sending"],"isRequired":true,"uniqueKey":"records.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"uid":{"description":"User ID","type":"string","isRequired":true,"uniqueKey":"records.items.[INDEX].uid","typeLabel":"string"},"comment":{"properties":{"tags":{"default":[],"items":{"type":"string","uniqueKey":"records.items.[INDEX].comment.tags.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"records.items.[INDEX].comment.tags","typeLabel":"string[]"},"text":{"default":"","type":"string","uniqueKey":"records.items.[INDEX].comment.text","typeLabel":"string"}},"description":"Comment to set for the fax job","type":"object","uniqueKey":"records.items.[INDEX].comment","typeLabel":"object"},"contact_name":{"type":"string","uniqueKey":"records.items.[INDEX].contact_name","typeLabel":"string"},"designated_src":{"type":"string","uniqueKey":"records.items.[INDEX].designated_src","typeLabel":"string"},"extra_info":{"type":"object","uniqueKey":"records.items.[INDEX].extra_info","typeLabel":"object"},"file_changes":{"items":{"properties":{"at":{"type":"string","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].at","typeLabel":"string"},"files":{"items":{"properties":{"file_name":{"type":"string","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].files.items.[INDEX].file_name","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].files.items.[INDEX].mime_type","typeLabel":"string"},"size":{"type":"number","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].files.items.[INDEX].size","typeLabel":"number"}},"type":"object","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].files.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX].files","typeLabel":"object[]"}},"type":"object","uniqueKey":"records.items.[INDEX].file_changes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"records.items.[INDEX].file_changes","typeLabel":"object[]"},"files":{"description":"Files to send","items":{"type":"string","uniqueKey":"records.items.[INDEX].files.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"records.items.[INDEX].files","typeLabel":"string[]"},"initiated_from":{"properties":{"from_id":{"type":"string","uniqueKey":"records.items.[INDEX].initiated_from.from_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"records.items.[INDEX].initiated_from.type","typeLabel":"string"}},"type":"object","uniqueKey":"records.items.[INDEX].initiated_from","typeLabel":"object"},"ip":{"description":"IP address from which the send request originated","type":"string","uniqueKey":"records.items.[INDEX].ip","typeLabel":"string"},"last_updated_status_time":{"description":"Time and date when the send request status was last updated. Format: *YYYY-MM-DD HH:mm:ss*","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}","type":"string","uniqueKey":"records.items.[INDEX].last_updated_status_time","typeLabel":"string"},"options":{"properties":{"enhancement":{"description":"Text enhancement. Set to True to optimize fax file for text.","default":true,"type":"boolean","uniqueKey":"records.items.[INDEX].options.enhancement","typeLabel":"boolean"},"retry":{"description":"Fax retry settings","example":{"retry":{"count":2,"delay":10}},"properties":{"count":{"description":"Number of tries to send the fax","maximum":3,"minimum":0,"type":"integer","uniqueKey":"records.items.[INDEX].options.retry.count","typeLabel":"integer"},"delay":{"description":"Delay in minutes between two retries (0-720)","maximum":720,"minimum":0,"type":"integer","uniqueKey":"records.items.[INDEX].options.retry.delay","typeLabel":"integer"}},"type":"object","additionalProperties":false,"uniqueKey":"records.items.[INDEX].options.retry","typeLabel":"object"},"partially_sent_retry":{"type":"boolean","description":"Enable automatic retry for partially sent faxes. Please make sure that the remote will accept chunked submissions before using it","uniqueKey":"records.items.[INDEX].options.partially_sent_retry","typeLabel":"boolean"}},"description":"Additional configuration for sending a fax","type":"object","uniqueKey":"records.items.[INDEX].options","typeLabel":"object"},"page_count":{"description":"Number of fax pages","minimum":0,"type":"integer","uniqueKey":"records.items.[INDEX].page_count","typeLabel":"integer"},"retry":{"description":"Fax retry settings","example":{"retry":{"count":2,"delay":10}},"properties":{"count":{"description":"Number of tries to send the fax","maximum":3,"minimum":0,"type":"integer","uniqueKey":"records.items.[INDEX].retry.count","typeLabel":"integer"},"delay":{"description":"Delay in minutes between two retries (0-720)","maximum":720,"minimum":0,"type":"integer","uniqueKey":"records.items.[INDEX].retry.delay","typeLabel":"integer"}},"type":"object","additionalProperties":false,"uniqueKey":"records.items.[INDEX].retry","typeLabel":"object"},"send_time":{"type":"string","uniqueKey":"records.items.[INDEX].send_time","typeLabel":"string"},"should_enhance":{"type":"boolean","uniqueKey":"records.items.[INDEX].should_enhance","typeLabel":"boolean"},"src":{"type":"string","uniqueKey":"records.items.[INDEX].src","typeLabel":"string"},"status_changes":{"items":{"properties":{"at":{"description":"Date and time at which status changed. Format: *YYYY-MM-DD HH:mm:ss*","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}","type":"string","isRequired":true,"uniqueKey":"records.items.[INDEX].status_changes.items.[INDEX].at","typeLabel":"string"},"status":{"description":"Outbound fax status","type":"string","enum":["submitted","converting","scheduled_for_sending","sending"],"isRequired":true,"uniqueKey":"records.items.[INDEX].status_changes.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["at","status"],"type":"object","uniqueKey":"records.items.[INDEX].status_changes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"records.items.[INDEX].status_changes","typeLabel":"object[]"},"submit_time":{"description":"Date and time when the fax was submitted for sending","type":"string","uniqueKey":"records.items.[INDEX].submit_time","typeLabel":"string"},"to":{"items":{"type":"string","uniqueKey":"records.items.[INDEX].to.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"records.items.[INDEX].to","typeLabel":"string[]"},"cover_page":{"description":"Fax cover page","type":"object","required":["name_to","name_from","subject"],"properties":{"name_to":{"type":"string","description":"TO field on the cover page","isRequired":true,"uniqueKey":"records.items.[INDEX].cover_page.name_to","typeLabel":"string"},"name_from":{"type":"string","description":"FROM field on the cover page","isRequired":true,"uniqueKey":"records.items.[INDEX].cover_page.name_from","typeLabel":"string"},"subject":{"type":"string","description":"SUBJECT field on the cover page","isRequired":true,"uniqueKey":"records.items.[INDEX].cover_page.subject","typeLabel":"string"},"flags":{"type":"array","description":"Cover page flags","items":{"description":"Allowed flags for the cover page","type":"string","enum":["urgent","for_review","please_reply","confidential"],"uniqueKey":"records.items.[INDEX].cover_page.flags.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"records.items.[INDEX].cover_page.flags","typeLabel":"enum\u003cstring>[]"},"message":{"type":"string","description":"MESSAGE field on the cover page","uniqueKey":"records.items.[INDEX].cover_page.message","typeLabel":"string"},"include_company_logo":{"type":"boolean","description":"Use company logo on the cover page","uniqueKey":"records.items.[INDEX].cover_page.include_company_logo","typeLabel":"boolean"}},"uniqueKey":"records.items.[INDEX].cover_page","typeLabel":"object"}},"required":["id","uid","status"],"additionalProperties":false,"uniqueKey":"records.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"records","typeLabel":"object[]"}},"required":["records"],"type":"object","uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"records":[{"comment":{"tags":[],"text":""},"contact_name":"","designated_src":"","extra_info":{},"file_changes":[],"files":["/transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df"],"id":"13a4afb0585345639733857e8f36df8d","initiated_from":{"from_id":"","type":""},"ip":"8.8.8.8","last_updated_status_time":"2017-09-24 06:43:04","options":{},"page_count":0,"retry":{"count":0,"delay":0},"send_time":"2017-09-24 06:43:04 +0000","should_enhance":false,"src":"+16699990000","status":"submitted","status_changes":[{"at":"2017-09-24 06:43:04","status":"submitted"}],"submit_time":"2017-09-24 06:43:04 +0000","to":["+16699990000"],"uid":"53a1afb8585345a39033857e1f36bf8d"}]}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"alohi-faxplus","siteName":"Fax.Plus API","title":"Outbox - Fax.Plus API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T07:07:06.905Z","originalFileLocation":"concepts/outbox.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Fax.Plus API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Outbox - Fax.Plus API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fax.Plus API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidoc.fax.plus/concepts/outbox\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://alohi-faxplus.mintlify.app/_mintlify/api/og/v2?division=Concepts\u0026amp;title=Outbox\u0026amp;theme=272e38d3eb846d4b16001ad8\u0026amp;signature=0d4676f1eb86161fe6f3f9d239ff50a2608b792cb33b892d9e7eb57375e66c90\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Outbox - Fax.Plus API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://alohi-faxplus.mintlify.app/_mintlify/api/og/v2?division=Concepts\u0026amp;title=Outbox\u0026amp;theme=272e38d3eb846d4b16001ad8\u0026amp;signature=0d4676f1eb86161fe6f3f9d239ff50a2608b792cb33b892d9e7eb57375e66c90\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/alohi-faxplus/gBaghwJZPAqfFFRa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fax.Plus API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0a69ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidoc.fax.plus/concepts/outbox\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/concepts/outbox.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidoc.fax.plus/#organization\",\"name\":\"Fax.Plus API\",\"url\":\"https://apidoc.fax.plus\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/alohi-faxplus/cC0DzEP8P19x5X1k/resources/logo/light.svg?fit=max\u0026auto=format\u0026n=cC0DzEP8P19x5X1k\u0026q=85\u0026s=56dd58e11c610ad1e40f907dc8a01cec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidoc.fax.plus#website\",\"name\":\"Fax.Plus API\",\"url\":\"https://apidoc.fax.plus\",\"publisher\":{\"@id\":\"https://apidoc.fax.plus/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidoc.fax.plus/concepts/outbox#webpage\",\"url\":\"https://apidoc.fax.plus/concepts/outbox\",\"name\":\"Outbox\",\"dateModified\":\"2026-10-16T07:07:06.905Z\",\"isPartOf\":{\"@id\":\"https://apidoc.fax.plus#website\"},\"breadcrumb\":{\"@id\":\"https://apidoc.fax.plus/concepts/outbox#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidoc.fax.plus/concepts/outbox#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Concepts\",\"item\":\"https://apidoc.fax.plus/concepts/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Outbox\",\"item\":\"https://apidoc.fax.plus/concepts/outbox\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidoc.fax.plus/concepts/outbox#apireference\",\"headline\":\"Outbox\",\"name\":\"Outbox\",\"url\":\"https://apidoc.fax.plus/concepts/outbox\",\"mainEntityOfPage\":{\"@id\":\"https://apidoc.fax.plus/concepts/outbox#webpage\"},\"dateModified\":\"2026-10-16T07:07:06.905Z\",\"publisher\":{\"@id\":\"https://apidoc.fax.plus/#organization\"},\"isPartOf\":{\"@id\":\"https://apidoc.fax.plus#website\"}}]}\u003c/script>","siteName":"Fax.Plus API","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"graduation-cap","href":"https://help.alohi.com/hc/en-us"},{"anchor":"Release Notes","icon":"rss","href":"https://www.alohi.com/release-notes"},{"anchor":"Compliance \u0026 Security","icon":"shield-halved","href":"https://www.alohi.com/trust/compliance"},{"anchor":"Blog","icon":"newspaper","href":"https://www.alohi.com/blog"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"fax","href":"/get-started/introduction"},{"title":"Quickstart","icon":"bolt","href":"/get-started/quickstart"}]},{"group":"MCP","pages":[{"title":"Fax.Plus MCP Server","href":"/get-started/fax-plus-mcp"}]},{"group":"Concepts","pages":[{"title":"Authentication","icon":"lock","href":"/concepts/authentication"},{"title":"Fax","icon":"fax","description":null,"href":"/concepts/fax"},{"title":"Outbox","icon":"inbox","href":"/concepts/outbox"},{"title":"Number","icon":"phone","description":null,"href":"/concepts/number"},{"title":"Webhook","icon":"bell","href":"/concepts/webhook"},{"title":"Shop","icon":"cart-shopping","href":"/concepts/shop"}]},{"group":"SDKs","pages":[{"title":"Python","icon":"python","href":"/backend-sdks/python"},{"title":"Javascript","icon":"js","href":"/backend-sdks/javascript"}]},{"group":"API Reference","pages":[{"group":"Authentication","icon":"key","pages":[{"openapi":"get /auth/token","title":"Get token information","href":"/api-reference/endpoints/authentication/get-token-info"}]},{"group":"Accounts","icon":"circle-user","pages":[{"openapi":"get /accounts","title":"List corporate members","href":"/api-reference/endpoints/accounts/list-corporate-members"},{"openapi":"get /accounts/{user_id}","title":"Get account information","href":"/api-reference/endpoints/accounts/get-account-information"},{"openapi":"get /accounts/{user_id}/plan","title":"Get user plan","href":"/api-reference/endpoints/accounts/get-user-plan"},{"openapi":"put /accounts/{user_id}","title":"Modify account information","href":"/api-reference/endpoints/accounts/modify-account-information"},{"openapi":"get /accounts/self/member-details/{member_user_id}","title":"Get member details","href":"/api-reference/endpoints/accounts/get-member-details"},{"openapi":"put /accounts/self/member-details/{member_user_id}","title":"Modify member details","href":"/api-reference/endpoints/accounts/modify-member-details"},{"openapi":"post /accounts/self/member-invitations","title":"Invite corporate members","href":"/api-reference/endpoints/accounts/invite-corporate-members"},{"openapi":"patch /accounts/self/member-invitations","title":"Resend corporate member invitations","href":"/api-reference/endpoints/accounts/resend-member-invitations"}]},{"group":"Numbers","icon":"phone","pages":[{"openapi":"get /accounts/{user_id}/numbers","title":"List phone numbers","href":"/api-reference/endpoints/numbers/list-phone-numbers"},{"openapi":"get /accounts/{user_id}/numbers/{number}","title":"Get number information","href":"/api-reference/endpoints/numbers/get-number-information"},{"openapi":"put /accounts/{user_id}/numbers/{number}","title":"Assign number","href":"/api-reference/endpoints/numbers/assign-number"},{"openapi":"delete /accounts/{user_id}/numbers/{number}","title":"Revoke number","href":"/api-reference/endpoints/numbers/revoke-number"}]},{"group":"Faxes","icon":"fax","pages":[{"openapi":"get /accounts/{user_id}/faxes","title":"List fax records","href":"/api-reference/endpoints/faxes/list-fax-records"},{"openapi":"get /accounts/{user_id}/faxes/{fax_id}","title":"Get a fax record","href":"/api-reference/endpoints/faxes/get-a-fax-record"},{"openapi":"put /accounts/{user_id}/faxes/{fax_id}","title":"Modify fax record","href":"/api-reference/endpoints/faxes/modify-fax-record"},{"openapi":"delete /accounts/{user_id}/faxes/{fax_id}","title":"Delete a fax","href":"/api-reference/endpoints/faxes/delete-a-fax"},{"openapi":"put /accounts/{user_id}/faxes","title":"Bulk update fax records","href":"/api-reference/endpoints/faxes/bulk-update-fax-records"},{"openapi":"delete /accounts/{user_id}/faxes","title":"Bulk delete fax records","href":"/api-reference/endpoints/faxes/bulk-delete-fax-records"}]},{"group":"Fax AI","icon":"sparkles","pages":[{"openapi":"get /accounts/{user_id}/faxes/{fax_id}/ai/ocr","title":"Get fax OCR result","href":"/api-reference/endpoints/fax-ai/get-fax-ai-ocr"},{"openapi":"post /accounts/{user_id}/faxes/{fax_id}/ai/ocr","title":"Trigger fax OCR","href":"/api-reference/endpoints/fax-ai/trigger-fax-ai-ocr"},{"openapi":"get /accounts/{user_id}/faxes/{fax_id}/ai/field-extraction","title":"Get fax field extraction result","href":"/api-reference/endpoints/fax-ai/get-fax-ai-field-extraction"},{"openapi":"post /accounts/{user_id}/faxes/{fax_id}/ai/field-extraction","title":"Trigger fax field extraction","href":"/api-reference/endpoints/fax-ai/trigger-fax-ai-field-extraction"},{"openapi":"patch /accounts/{user_id}/faxes/{fax_id}/ai/field-extraction","title":"Update extracted fields","href":"/api-reference/endpoints/fax-ai/update-fax-ai-field-extraction"},{"openapi":"get /accounts/self/ai/custom-fields","title":"List AI custom field definitions","href":"/api-reference/endpoints/fax-ai/list-ai-custom-fields"},{"openapi":"post /accounts/self/ai/custom-fields","title":"Create AI custom field definition","href":"/api-reference/endpoints/fax-ai/create-ai-custom-field"},{"openapi":"patch /accounts/self/ai/custom-fields/{field_id}","title":"Update AI custom field definition","href":"/api-reference/endpoints/fax-ai/update-ai-custom-field"},{"openapi":"delete /accounts/self/ai/custom-fields/{field_id}","title":"Delete AI custom field definition","href":"/api-reference/endpoints/fax-ai/delete-ai-custom-field"},{"openapi":"get /accounts/self/ai/credits","title":"Get AI credit summary","href":"/api-reference/endpoints/fax-ai/get-ai-credits"},{"openapi":"get /accounts/self/ai/settings","title":"Get fax AI settings","href":"/api-reference/endpoints/fax-ai/get-fax-ai-settings"},{"openapi":"patch /accounts/self/ai/settings","title":"Update fax AI settings","href":"/api-reference/endpoints/fax-ai/update-fax-ai-settings"}]},{"group":"Contacts","icon":"address-book","pages":[{"openapi":"get /accounts/self/contacts","title":"List contacts","href":"/api-reference/endpoints/contacts/list-contacts"},{"openapi":"post /accounts/self/contacts","title":"Create a contact","href":"/api-reference/endpoints/contacts/create-contact"},{"openapi":"put /accounts/self/contacts/{contact_id}","title":"Update a contact","href":"/api-reference/endpoints/contacts/update-contact"},{"openapi":"delete /accounts/self/contacts/{contact_id}","title":"Delete a contact","href":"/api-reference/endpoints/contacts/delete-contact"},{"openapi":"post /accounts/self/contacts/share","title":"Share contacts","href":"/api-reference/endpoints/contacts/share-contacts"},{"openapi":"get /accounts/self/contact-groups","title":"List contact groups","href":"/api-reference/endpoints/contacts/list-contact-groups"},{"openapi":"post /accounts/self/contact-groups","title":"Create a group","href":"/api-reference/endpoints/contacts/create-contact-group"},{"openapi":"put /accounts/self/contact-groups/{group_id}","title":"Update a group","href":"/api-reference/endpoints/contacts/update-contact-group"},{"openapi":"delete /accounts/self/contact-groups/{group_id}","title":"Delete a group","href":"/api-reference/endpoints/contacts/delete-contact-group"},{"openapi":"post /accounts/self/contact-groups/share","title":"Share groups","href":"/api-reference/endpoints/contacts/share-contact-groups"},{"openapi":"post /accounts/self/contacts/assign-groups","title":"Assign contacts to groups","href":"/api-reference/endpoints/contacts/assign-contacts-to-groups"}]},{"group":"Files","icon":"file","pages":[{"openapi":"post /accounts/{user_id}/files","title":"Upload a file","href":"/api-reference/endpoints/files/upload-a-file"},{"openapi":"get /accounts/{user_id}/files/{fax_id}","title":"Download fax file","href":"/api-reference/endpoints/files/download-fax-file"},{"openapi":"get /accounts/{user_id}/files/{fax_id}/page/{page_num}","title":"Download single fax page","href":"/api-reference/endpoints/files/download-fax-file-page"},{"openapi":"get /accounts/{user_id}/report/{fax_id}","title":"Get fax confirmation report","href":"/api-reference/endpoints/files/get-fax-confirmation-report"},{"openapi":"get /accounts/{user_id}/thumbnail/{fax_id}","title":"Get fax thumbnail","href":"/api-reference/endpoints/files/get-fax-thumbnail"}]},{"group":"Outbox","icon":"inbox","pages":[{"openapi":"get /accounts/{user_id}/outbox","title":"List faxes in the outbox","href":"/api-reference/endpoints/outbox/list-faxes-in-the-outbox"},{"openapi":"post /accounts/{user_id}/outbox","title":"Send a fax","href":"/api-reference/endpoints/outbox/send-a-fax"},{"openapi":"get /accounts/{user_id}/outbox/{outbox_fax_id}","title":"Get outgoing fax","href":"/api-reference/endpoints/outbox/list-outgoing-faxes"},{"openapi":"put /accounts/{user_id}/outbox/{outbox_fax_id}","title":"Modify an outgoing fax","href":"/api-reference/endpoints/outbox/modify-an-outgoing-fax"},{"openapi":"delete /accounts/{user_id}/outbox/{outbox_fax_id}","title":"Delete an outgoing fax","href":"/api-reference/endpoints/outbox/delete-an-outgoing-fax"},{"openapi":"put /accounts/{user_id}/outbox","title":"Bulk update outbox faxes","href":"/api-reference/endpoints/outbox/bulk-update-outbox-faxes"},{"openapi":"delete /accounts/{user_id}/outbox","title":"Bulk delete outbox faxes","href":"/api-reference/endpoints/outbox/bulk-delete-outbox-faxes"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhook endpoints","openapi":"get /webhooks","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","openapi":"post /webhooks","href":"/api-reference/endpoints/webhooks/create-webhook-endpoint"},{"title":"Update a webhook endpoint","openapi":"patch /webhooks/{endpoint_id}","href":"/api-reference/endpoints/webhooks/update-webhook-endpoint"},{"title":"Delete a webhook endpoint","openapi":"delete /webhooks/{endpoint_id}","href":"/api-reference/endpoints/webhooks/delete-webhook-endpoint"},{"title":"List user webhooks (Legacy)","openapi":"get /hooks","href":"/api-reference/endpoints/webhooks/list-user-webhooks"},{"title":"Register new webhook (Legacy)","openapi":"post /hooks","href":"/api-reference/endpoints/webhooks/register-new-webhook"},{"title":"Delete webhook (Legacy)","openapi":"delete /hooks/{hook_id}","href":"/api-reference/endpoints/webhooks/delete-webhook"}]},{"group":"Shop","icon":"cart-shopping","pages":[{"openapi":"get /shop/balance","title":"Get account balance","href":"/endpoints/shop/get-account-balance"},{"openapi":"get /shop/numbers/countries","title":"List countries","href":"/endpoints/shop/list-countries"},{"openapi":"get /shop/numbers/countries/{country_code}/areas","title":"List areas","href":"/endpoints/shop/list-areas"},{"openapi":"get /shop/numbers/countries/{country_code}/areas/{calling_code}/numbers","title":"List available numbers","href":"/endpoints/shop/list-available-numbers"},{"openapi":"post /shop/numbers/purchase","title":"Purchase a number","href":"/endpoints/shop/purchase-a-number"}]}]}]}]},"basePath":"","title":"Outbox - Fax.Plus API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","07c022d89b","a74be98ba7","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Frame-DW6UFrUy.js","zoom-image-lightbox-eHyQ0tlO.js","lightbox-handle-r17bVUz3.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}