Fax.Plus

Assign multiple contacts to multiple groups. **Important:** This operation overwrites existing group assignments for the specified contacts - it does not append to them. Contacts will be unassigned from any group that's not included in this list (Permitted scopes: **fax:all:edit**)

Bulk delete multiple fax records. Maximum 50 fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Bulk delete (cancel) multiple outbox fax records. Maximum 10 outbox fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Bulk update multiple fax records (mark as read/unread and/or update comment). Maximum 100 fax IDs per request. Duplicate IDs are automatically ignored. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Bulk update multiple outbox fax records (update comment). Maximum 100 outbox fax IDs per request. Duplicate IDs are automatically ignored. Jobs in 'sending' status cannot be updated and will return a 409 status code. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Create a new custom field definition for AI field extraction. Admin-only. (Permitted scopes: **fax:all:edit**, **fax:ai_settings:edit**)

Create a new contact (Permitted scopes: **fax:all:edit**)

Create a new contact group (Permitted scopes: **fax:all:edit**)

**Legacy** `POST /hooks`. Prefer `POST /webhooks`. Register a new webhook which will be called on a specific event. See the WebhookCallback model. (Permitted scopes: **fax:all:edit**, **fax:webhook:edit**)

Delete a custom field definition. Admin-only. (Permitted scopes: **fax:all:edit**, **fax:ai_settings:edit**)

Delete a contact (Permitted scopes: **fax:all:edit**)

Delete a specific fax record by providing its id. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Delete an outgoing fax that is being scheduled for sending. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Delete a group (Permitted scopes: **fax:all:edit**)

**Legacy** `DELETE /hooks/{hook_id}`. Prefer `DELETE /webhooks/{endpoint_id}`. Delete a webhook by its ID. (Permitted scopes: **fax:all:edit**, **fax:webhook:edit**)

Get account information of all non-admin members of your corporate account. Only the admin account can send a request to this endpoint which returns the accounts of all members (Permitted scopes: **fax:all:read**, **fax:member:read**)

Get the AI credit summary including remaining credits, usage breakdown by feature, and next reload date. (Permitted scopes: **fax:all:read**, **fax:ai:read**)

Get your account balance. (Permitted scopes: **fax:all:read**, **fax:shop:read**)

Get a specific fax record details like duration, pages etc. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

Get the field extraction processing status and extracted data for a fax. Returns status and extracted fields when processing is finished. (Permitted scopes: **fax:all:read**, **fax:ai:read**)

Get the OCR processing status and extracted text for a fax. Returns status and text data when processing is finished. (Permitted scopes: **fax:all:read**, **fax:ai:read**)

Get fax AI auto-trigger settings for the organization. (Permitted scopes: **fax:all:read**, **fax:ai_settings:read**)

Fetches a Fax.Plus confirmation report as bounded PDF data, stores it in the session Blob mount, and returns a short-lived download URL instead of binary JSON output.

Fetches a Fax.Plus fax thumbnail as bounded binary data, stores it in the session Blob mount, and returns a short-lived download URL instead of binary JSON output.

Fetches a sent or received Fax.Plus file as bounded binary data, stores it in the session Blob mount, and returns a short-lived download URL instead of binary JSON output.

Fetches one Fax.Plus fax page as bounded TIFF data, stores it in the session Blob mount, and returns a short-lived download URL instead of binary JSON output.

Get corporate member's role and faxing quota (Permitted scopes: **fax:all:read**, **fax:member:read**)

Get information about a single purchased/assigned fax number (Permitted scopes: **fax:all:read**, **fax:numbers:read**)

Get specific details of a fax currently scheduled for sending. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

Returns metadata about the current access token including type, scopes, expiration date, and PAT-specific information if applicable. For PAT tokens, returns full metadata (id, name, preview, created/expiration dates, last used). For OAuth tokens, returns token type and scopes only.

Get information about an account. For members user_id can only be self. For admin it can be either self, or a user_id of any corporate member. (Permitted scopes: **fax:all:read**, **fax:member:read**, **fax:user:read**)

**Legacy** `GET /hooks`. Prefer `GET /webhooks`. Returns a list of currently registered webhooks for the requested **event**. (Permitted scopes: **fax:all:read**, **fax:webhook:read**)

Invite new users to join your corporate account by sending them email invitations (maximum 10 per request). Only corporate admins with appropriate permissions can use this endpoint. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)

Get all custom field definitions for AI field extraction. (Permitted scopes: **fax:all:read**, **fax:ai_settings:read**)

Get a list of areas where you can purchase fax numbers for a specific country. (Permitted scopes: **fax:all:read**, **fax:shop:read**)

Get user contacts with optional filters, pagination, or retrieve specific contacts by IDs (Permitted scopes: **fax:all:read**)

Get a list of countries where you can purchase fax numbers. (Permitted scopes: **fax:all:read**, **fax:shop:read**)

Get your own or your subordinate's faxes list. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

List your purchased/assigned phone numbers. For corporate members all assigned numbers will be returned, while for the corporate admin, all purchased numbers. (Permitted scopes: **fax:all:read**, **fax:numbers:read**)

Get a list of the faxes in the outbox which were not yet sent. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

Get a list of available fax numbers for a specific area. (Permitted scopes: **fax:all:read**, **fax:shop:read**)

Get contact groups with optional search and pagination. You can also retrieve specific groups by providing comma-separated IDs (Permitted scopes: **fax:all:read**)

Purchase an available fax number. (Permitted scopes: **fax:all:edit**, **fax:shop:edit**)

Resend email invitations to users who have not yet signed up for your corporate account (maximum 10 per request). Only corporate admins with appropriate permissions can use this endpoint. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)

Revoke fax number from a corporate member. To revoke your own number use self as a user_id. (Permitted scopes: **fax:all:edit**, **fax:numbers:edit**)

Send a fax to one or more destinations. For corporate members without a fax number assigned set the 'from' parameter to 'no_number'. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**). To randomly select one of the available numbers per recipient, use comma-separated string.

Share contacts with all corporate members (Permitted scopes: **fax:all:edit**)

Share groups with all corporate members (Permitted scopes: **fax:all:edit**)

Trigger AI field extraction for a fax. Extracts structured data fields from the fax content. If extraction is already finished, returns the existing result. Consumes AI credits. (Permitted scopes: **fax:all:edit**, **fax:ai:edit**)

Trigger OCR processing for a fax. If OCR is already finished, returns the existing result. Consumes AI credits. (Permitted scopes: **fax:all:edit**, **fax:ai:edit**)

Update an existing custom field definition. Admin-only. (Permitted scopes: **fax:all:edit**, **fax:ai_settings:edit**)

Update an existing contact (Permitted scopes: **fax:all:edit**)

You can modify a fax record's comment or mark it as read. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Update the extracted field data with user corrections. Only allowed when field extraction status is finished. (Permitted scopes: **fax:all:edit**, **fax:ai:edit**)

Update fax AI auto-trigger settings. Admin-only. Supports partial updates. (Permitted scopes: **fax:all:edit**, **fax:ai_settings:edit**)

Update corporate member's role and faxing quota. (Permitted scopes: **fax:all:edit**, **fax:member:edit**)

Assign fax number to a corporate member (Permitted scopes: **fax:all:edit**, **fax:numbers:edit**)

Modify an outgoing fax that is being scheduled for sending. (Permitted scopes: **fax:all:edit**, **fax:fax:edit**)

Update an existing group (Permitted scopes: **fax:all:edit**)

Modify personal information of your own account or your corporate member's account. user_id can be either self, or a subordinate's user_id. (Permitted scopes: **fax:all:edit**, **fax:member:edit**, **fax:user:edit**)

Uploads a staged PDF or TIFF file to Fax.Plus and returns the file path used to send a fax.