Add an image
|
1 |
POST /api/1/image |
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
|
1 2 3 4 5 6 7 8 9 10 11 12 |
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 |
curl
|
1 |
curl -X POST -H "Authorization: Bearer e8c0f284c3f68ceca1a6ffd5f65a7a4" -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW" -F "file=message API example.jpg" https://restapi.actonsoftware.com/api/1/image |
Response
A successful request results in an HTTP 200 response with a JSON object that contains an id that uses hex, like the following:
|
1 2 3 4 5 |
{ "status": "success", "message": "The file has been uploaded", "id": "f-000b" } |
