Skip to main content
DELETE
Delete Fax

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Fax ID

Pattern: ^[1-9]\d*$

Query Parameters

paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
query
string

Search by source number, destination number, or sender name

direction
enum<string>
Available options:
IN,
OUT
startDate
string

ISO start date filter

endDate
string

ISO end date filter

tenantId
string
required

Tenant ID to list faxes for

Pattern: ^[1-9]\d*$
branchId
string

Filter to a branch

Pattern: ^[1-9]\d*$

Response

200 - application/json

Deleted fax

id
number
required
tenantId
number
required
sourceNum
string
required
sourceName
string
required
destNum
string
required
remoteId
string
required
direction
string
required
date
string
required

Fax date (ISO 8601)

pages
number
required
status
string
required
error
string
required
statusEmail
string
required
attempt
number
required
branchId
number
required