Skip to content

Upload Inbox Note Attachment

POST
/inbox/notes/attachments

Upload a file for an INTERNAL note (multipart: file).

Returns the attachment ref (token, key, name, size, contentType) that POST /inbox/channels/{channel_id}/comments accepts in attachments. Notes are internal, so nothing reaches a customer.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
file
required

One file, up to 25 MB.

string format: binary

Responses

201

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string