Upload image
POST/images/:siteId/uploadImage
Id of the project site for which the image is being uploaded
Request
Path Parameters
- application/json
Body
Responses
- 200
- 400
- 403
- 423
- 500
OK
- */*
- Schema
- Example (from schema)
Schema
Image base color
Account Id of the image uploader
Date the image was uploaded
Image file name
Image file size in KB
Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG)
Possible values: [PNG
, JPEG
, GIF
, SVG
, MVG
, WEB
]
Image height in pixels
Unique Id of the image
Keyword(s) associated with the image
Image name
Image path
Indicates if the image has been shared
Unique Id of the site your project is associated with
Image size in bytes. Image file size should be maximum 5242880 bytes
Image source
URL or the image source
Image width in pixels
{
"baseColor": 0,
"colorDepth": 0,
"createdById": 0,
"date": "2024-07-29T15:51:28.071Z",
"fileName": "string",
"fileWeight": 0,
"format": "PNG",
"height": 0,
"id": 0,
"keywords": [
"string"
],
"name": "string",
"path": "string",
"shared": true,
"siteId": 0,
"size": 0,
"source": "string",
"sourceUrl": "string",
"width": 0
}
Bad Request
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Locked
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}