//temp/file/:field POST

Overview

Saves an image to a temporary folder.

Request Arguments

Name	Type	Description	Required
format	String	The data format. Currently accepts 'sugar-html-json'.	True
delete_if_fails	Boolean	Indicates whether the API is to mark related record deleted if the file upload fails.	False
oauth_token	String	The oauth_token value.	False - Required if only if delete_if_fails is true.
<image field>	String	The field and file to populate. Example: `{"":"@\/path\/to\/ExampleImage.png"}`	True

Request

{
   "format":"sugar-html-json",
   "delete_if_fails":true,
   "oauth_token":"8d240d9d-04ea-571b-35ea-513037ed5857",
   "<image field>":"@\/path\/to\/\/ExampleImage.png"
}

Response Arguments

Name	Type	Description
guid	String	The temp ID of the image.

Response

{
   "picture":{
      "guid":"50a8760d-966f-9d7e-f45c-513037fac8fc"
   }
}

Change Log

Version	Change
v10	Added `/<module>/temp/file/:field` POST endpoint.