Files API reference

Files endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 3 days ago

This is the reference for the Files endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

  • POST /files: Upload a file

Upload a file

POST /api/v1/files

Upload a file so it can be attached to a conversation reply, note, or ticket. Send the raw file bytes as the request body (not multipart/form-data) and the file name as the name query parameter. The response carries a fileId: attach it by setting attachments: [{ fileId }] on the reply/note/ticket request.

Parameters

Name

In

Type

Required

Description

name

query

string

Yes

File name, including its extension

Response 201: returns fileId, url, name, contentType, size, family.

Was this helpful?

Your feedback shapes what we write next.