POST Logo

Overview

The following table contains important information about the POST method to upload a logo.

POST Method
Method	POST
URL or Endpoint	/api/projects/`projectId`/uploads/image
Headers	Authorization
Parameters	projectId
Body	folder, file

The description of the URL parameters is as follows:

`projectId` URL Parameter
URL Parameter Name	`projectId`
Mandatory	Yes
Type	string
Description	Unique identifier for project

Request Body

The description of the parameters is as follows:

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from the back-end.
result	object	Returns the response object containing details about the file.
path	string	The absolute URL of the uploaded file.
relativePath	string	The relative path to the file within the storage system.
blobPath	string	Path for the blob storage, if applicable.
resultInfo	string	Returns extra information about the result, if any.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: