Skip to main content
POST
Mark Fax Read

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

fax_id
string
required

Response

Successful Response

Compact fax row for list views.

id
string
required
direction
enum<string>
required

Direction of a fax. INBOUND is defined now so inbound work later just adds rows.

Available options:
OUTBOUND,
INBOUND
status
enum<string>
required

Lifecycle status of a fax. Values mirror SignalWire's LaML fax status values.

Available options:
QUEUED,
SENDING,
DELIVERED,
FAILED,
CANCELED,
NO_ANSWER,
BUSY
faxContact
FaxContactResponse · object | null
required
phoneNumberId
string | null
required
phoneNumberE164
string | null
required
numPages
integer | null
required
sentAt
string<date-time> | null
required
completedAt
string<date-time> | null
required
createdDate
string<date-time>
required
readDate
string<date-time> | null