Skip to main content
POST

Authorizations

​
Authorization
string
header
required

API key starting with sk_case_

Headers

​
Idempotency-Key
string

Required when mode is async; stable key for safely retrying the append

Required string length: 1 - 200

Path Parameters

​
id
string
required

Vault ID

​
objectId
string
required

ID of the vault object to append onto

Body

application/json
​
appendObjectIds
string[]
required

Vault object IDs whose pages will be appended onto the target object, in order. Must not include the target object itself. Sync mode accepts at most 20; async mode accepts at most 1000.

Required array length: 1 - 1000 elements
​
mode
enum<string>
default:sync

Use async to return immediately and receive completion through vault.object.append webhooks.

Available options:
sync,
async
​
rewriteLinks
boolean
default:false

When true, rewrites links in the target object to internal PDF jumps when the URL contains exactly one appended object ID as a standalone query parameter value or decoded path segment.

​
backLinks
boolean
default:false

Adds back links on appended pages

​
backLinksText
string
default:Back to Summary

Label text for the back link. Used only when backLinks is true and rendered centered at the bottom of each appended page.

Maximum string length: 120
​
clientReference
string

Caller-provided correlation value returned in async responses and webhooks.

Maximum string length: 200
​
bates
object

Optional Bates stamping for appended source PDFs. Numbering is deterministic across appendObjectIds order and does not stamp the target report pages.

Response

Target object updated successfully

​
id
string
​
vaultId
string
​
filename
string
​
contentType
string
​
sizeBytes
integer
​
checksum
string
​
ingestionStatus
string
​
pageCount
integer
​
appendedPageStart
integer

First 1-indexed page added by this append operation.

​
appendedPageEnd
integer

Last 1-indexed page added by this append operation.

​
objectId
string
​
bates
object
​
metadata
object
​
downloadUrl
string
​
expiresIn
integer
​
createdAt
string<date-time>