Submit Fax REST API doesn't contain "Notes" field appearing on the Cover Sheet

Andy Smetana

Is there a way to specify a content of "Notes" field in Submit Fax API? In current API documentation, I could not find it:

As a workaround I use "Inserts" field which appear in the Destinations:

E.g. I added «INS3» in my cover sheet template in place of Notes.

My only concern regarding this approach - is max field's length (255 chars). Notes can be lengthier. E.g. in other fax vendor Documo, they have this field on the API with max length up to 4000 chars.

So, does "Notes" field exist on the SendFax REST API? Maybe documentation misses it? E.g. in one of you cover sheet templates I see it:

Or if it was not defined on the API for the good reason - how would you suggest to add it?

Thank you,

Andy

Arun Prasad

Hi,

If the coversheet is registered, then the first document in the documents section of the request body will be considered as notes and the second document would be considered as the fax document.

Example request body snippet:

{
    "documents": [
        {
            "name": "notes.txt",
            "type": "text",
            "data": "VGhpcyBpcyBub3Rlcw==" //This is notes section
        },
        {
            "name": "temp.txt",
            "type": "text",
            "data": "SGkgVGhlcmUsIFRoaXMgaXMgYSB0ZXN0IERvY3VtZW50Lg==" //This is fax document section
        }
    ]
}

Attaching sample fax screenshot for your reference