Set an Image for a Category

POST 
/v1/categories/:categoryId/image

Set an Image for a Category

Request

Path Parameters

categoryId stringrequired

Id of the Category

multipart/form-data

Body

required

image binary

Responses

200

Successfully add an image to a Category

400

Bad request

application/json

Schema

Schema

error

object

code string

title string

message string

reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

TooManyAttachments

Upload - Too many attachments

{
  "error": {
    "code": "upload/too_many_files",
    "title": "Bad request",
    "message": "Too many files attached (max: 1)"
  }
}

ContentTypeError

Upload - Content type error

{
  "error": {
    "code": "upload/content_type_error",
    "title": "Bad request",
    "message": "Unsupported content type: xls"
  }
}

MaxFileSize

Upload - File exceeded max size

{
  "error": {
    "code": "upload/max_file_size",
    "title": "Bad request",
    "message": "Request size exceeded maximum for this endpoint (5242880 bytes)"
  }
}

FiletypeNotSupported

Upload - Filetype not supported

{
  "error": {
    "code": "upload/filetype_not_supported",
    "title": "Bad request",
    "message": "Filetype not supported.  Supported types include: pdf, png, jpg"
  }
}

BadRequest

400 Bad Request

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "Something is wrong with your request, please check any parameters and try again"
  }
}

401

Unauthorized

403

Forbidden

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

Example: Access is denied due to insufficient privileges

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to insufficient privileges"
  }
}

Loading...