v10 API call for /Mail/attachment POST syntax

Francesca Shiekh directing this straight to you as I believe you could assist, but asking for anyone else in the community for assistance.

We are trying to use v10 API call for /Mail/attachment POST (i.e. {"email_attachment":"@\/path\/to\/ExampleDocument.txt"}) to essentially attach an attachment to an email record which has been (successfully) created against a case.

We have tried picking-up the file from a network (UNC) location that that service account that the sugarCRM IIS webserver's page is being run as has permissions to and we have tried from a OneDrive (for Business) location as well with no luck.

In all cases, we receive the quoted error below; we have confirmed with Postman that the API call sent is no malformed and we have tried using a CURL call as well to no avail.

As both Manipulating File Attachments BASH and PHP official documentation is no help, as it provides examples of the v11 way to accomplish this using Notes, can you ask the community if they can provide a working example on how to successfully send a request to the v10 API call for /Mail/attachment POST.

We are just unsure of what the @\/path\/to\/ExampleDocument.txt should actually look like for an example where the file is in \\fileserver\share\folder\filename.ext

{

"error": "missing_parameter",

"error_message": "Attachment is missing",

}

Any assistance would be most appreciated!

Thanks and kind regards,

Nicholas Dohmen

0 Francesca Shiekh over 4 years ago

Nicholas Dohmen,
You give me too much credit, I've not used this before, but in reading the documentation at: https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_9.0/Integration/Web_Services/REST_API/E…
it looks like the use of the /Mail/attachment POST endpoint is discouraged.
In the Change Log you can see that v11 is the last version in which this is available. And the suggestion: Use /Notes/temp/file/filename POST in conjunction with /Emails/:record/link/attachments POST instead.
You can find the Emails POST described here:
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_9.0/Integration/Web_Services/REST_API/E…
There is a cookbook guide on manipulating Notes, including submitting a file attachment by creating a Note record using the /<module endpoint, and then submitting a File to the Note record using the /<module>/:record/file/:field endpoint.
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_9.1/Cookbook/Web_Services/REST_API/Bash…
As for the path: "@\/path\/to\/ExampleDocument.txt"
I was confused by the @, I had never seen an @ in a file path before. I did some googling and it seems it is an escape character. A 2011 post on Stack Overflow explains it: "It has nothing to do with filepath. It changes the escaping behavior of strings. In a string literal prefixed with @ the escape sequences starting with \ are disabled. This is convenient for filepaths since \ is the path separator and you don't want it to start an escape sequence."
c# - @(at) sign in file path/string - Stack Overflow
I hope this helps,
FrancescaS
Cancel
Vote Up +2 Vote Down

Sign in to reply

Verify Answer

Cancel
0 Nicholas Dohmen over 4 years ago in reply to Francesca Shiekh

Apologies for the delay in THANKING YOU! Thank you so much for all the information you responded with!!!
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel