Skip to main content
PUT
Update Inbox Document

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

id
integer<int32>
required

ID of the inbox document.

Body

application/json

Inbox document data to update.

Payload for updating an inbox document.

document
object

Document fields to update.

action
AttachPurchase · object

Optional action to perform (attach or create a purchase).

Response

200 - application/json

OK

A document in the inbox, pending processing.

id
integer<int32>
read-only
document
document · object

An invoice document (before booking).

source
object

Source of the document (e.g. email, upload).

action
object | null

Available action on this inbox document.

createdAt
string<date-time>
read-only
modifiedAt
string<date-time>
read-only
author
Reference to a user · object

Reference to a user.

modifier
Reference to a user · object

Reference to a user.