Submit a fax request

POST {{baseUrl}}/mra/v1/outbound/faxes

Submitting a request to send a fax requires use of pure JSON request body wherein the fax metadata (recipient fax numbers and user-specified options) and the document(s) to be faxed are part of the same JSON construct.

Request Body

{"destinations"=>[{"fax"=>"1234567891", "ref"=>"ref001", "inserts"=>[{"id"=>1, "value"=>"destination_insert_value"}, {"id"=>1, "value"=>"destination_insert_value"}]}, {"fax"=>"1234567891", "ref"=>"ref001", "inserts"=>[{"id"=>1, "value"=>"destination_insert_value"}, {"id"=>1, "value"=>"destination_insert_value"}]}], "documents"=>[{"type"=>"text", "data"=>"VGhpcyBpcyBzYW1wbGUgdGV4dCBkYXRh", "name"=>"temp.txt", "charset"=>"UTF-8"}, {"type"=>"text", "data"=>"VGhpcyBpcyBzYW1wbGUgdGV4dCBkYXRh", "name"=>"temp.txt", "charset"=>"UTF-8"}], "options"=>{"message_id"=>"temp_message_id", "billing_code"=>"temp_billing_code", "customer_reference"=>"temp_customer_reference", "end_time"=>"1948-06-02T14:25:26.056Z", "coversheet"=>{"enabled"=>true, "from"=>"ut et minim ex", "name"=>"f2m_default", "subject"=>"SampleSubject"}, "translation_options"=>{"fax_mode"=>"fine", "page_orientation"=>"landscape"}, "pilot_line"=>{"text"=>"SamplePilotText"}}, "reports"=>{"type"=>"conditional", "report_destinations"=>[{"fax"=>"1234567891"}, {"fax"=>"1234567891"}]}}

HEADERS

RESPONSES

status: OK

{"job_id":"xsi-1234567"}