Add an image

POST /api/1/image

1	POST /api/1/image

Add a new image to your account.

NOTE: This is a "multipart/form-data" post.

Parameters

Name	Parameter Type	Allow Multiple	Required/ Optional	Data Type	Description
Authorization:	Header	False	Required	String (Bearer {access token})	Pass the authentication token that was granted when you authorized access.
name	Form	False	Optional	String	The title/name of the image file to be added to the media library. If name is left blank the filename will be used.
file	Form	False	Required	Multipart	The image file to be added to the media library.
foldername	Form	False	Optional	String	The folder name to place the image file in. If foldername is left blank then the default value of 'Default Folder' will be used. If the folder name does not exist it will be created.

Request

HTTP

POST /api/1/image HTTP/1.1
Host: restapi.actonsoftware.com
Authorization: Bearer e8c0f284c3f68ceca1a6ffd5f65a7a4
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="message API example.jpg"
Content-Type: image/jpeg


----WebKitFormBoundary7MA4YWxkTrZu0gW

POST /api/1/image HTTP/1.1

Host: restapi.actonsoftware.com

Authorization: Bearer e8c0f284c3f68ceca1a6ffd5f65a7a4

Cache-Control: no-cache

Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW

Content-Disposition: form-data; name="file"; filename="message API example.jpg"

Content-Type: image/jpeg

----WebKitFormBoundary7MA4YWxkTrZu0gW

Response

A successful request results in an HTTP 200 response with a JSON object that contains an id that uses hex, like the following:

{"status":"success","message":"The file has been uploaded","id":"f-07c4cdc0-56ee-468e-8347-542a3fd381c1"}

1	{"status":"success","message":"The file has been uploaded","id":"f-07c4cdc0-56ee-468e-8347-542a3fd381c1"}

Code Examples

// This code requires the following modules
// "fs" (npm install fs)
// "request" (npm install request)

var fs = require("fs");
var request = require("request");

options = {
    method: "POST",
    url: "https://restapi.actonsoftware.com/api/1/image",

    headers: {
        "Authorization": "Bearer 12345678-9abc-defg-hijk-lmnopqrs",
        "Content-Type": "multipart/form-data"
    },
    formData : { name: 'test8',
     file: 
      { value: fs.createReadStream("/Users/john.doe/Downloads/test.png"),
        options: 
         { filename: '/Users/john.doe/Downloads/test.png'} } } };

request.post(options, function (err, res, body) {
    if(err) console.log(err);
    console.log(body);
});

// This code requires the following modules

// "fs" (npm install fs)

// "request" (npm install request)

var fs = require("fs");

var request = require("request");

options = {

method: "POST",

url: "https://restapi.actonsoftware.com/api/1/image",

headers: {

"Authorization": "Bearer 12345678-9abc-defg-hijk-lmnopqrs",

"Content-Type": "multipart/form-data"

formData : { name: 'test8',

file:

{ value: fs.createReadStream("/Users/john.doe/Downloads/test.png"),

options:

{ filename: '/Users/john.doe/Downloads/test.png'} } } };

request.post(options, function (err, res, body) {

if(err) console.log(err);

console.log(body);

});

curl -X POST https://restapi.actonsoftware.com/api/1/image -H 'Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -F file=@/Users/john.doe/Downloads/logo.png -F name=test2

1	curl -X POST https://restapi.actonsoftware.com/api/1/image -H 'Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -F file=@/Users/john.doe/Downloads/logo.png -F name=test2