v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Faxes

Bulk update fax records

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)

put/accounts/{user_id}/faxes

Path parameters

user_idstring required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

Request body

idsstring[] required

List of fax IDs to update (1-100 unique IDs, each ID is max 32 characters). Duplicates are automatically ignored.

is_readboolean

Mark faxes as read (true) or unread (false). Optional, but at least one of is_read or comment must be provided.

commentstring

Comment text to set for all faxes. Send empty string to remove comment. Optional, but at least one of is_read or comment must be provided.

Response

Response containing bulk operation results for faxes