Upload a file

You can use this endpoint to attach a file to an ongoing investigation.

The following file types are supported:

  • doc
  • docx
  • xls
  • xlsx
  • jpg
  • pdf
  • png

You can upload a file size of maximum 5MB per file.

File can be uploaded via multipart/form-data. You can upload one file at a time.

Request

URL: /api/v{version}/investigation/:supportTicketId/file

Method: POST

Content-Type: multipart/form-data

Response

HTTP status : 201 Created

If the file is uploaded successfully, then you will receive 201 Created response from the server.

The response contains metadata about the file (called fileId) in the response body.

68b2a410-a233-4400-9dfb-e8a2831bac11

Error Scenarios

  • If you provide a file bigger than 5mb size, the API will return an error as below:
{
    "title": "Bad Input",
    "status": 400,
    "detail": "File size is too large. Please upload a file smaller than 5242880 MB.",
    "traceId": "00-5e63dd08a42e4301590ab73c75ee6c9b-4cf294d4a788d99e-00",
    "errorCode": "INV0001"
}

  • If you provide a file type other than above supported file, the API will return an error as below:
{
    "title": "Bad Input",
    "status": 400,
    "detail": "Invalid File type. Please upload a .doc, .docx, .xls, .xlsx, .jpg, .pdf, .png file",
    "traceId": "00-37da1a1379f4734f8e5b158a19efc9ba-0d6d3c4633acb594-00",
    "errorCode": "INV0002"
}
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!