Append PDF vault objects onto an existing PDF vault object

{ "id": "<string>", "vaultId": "<string>", "filename": "<string>", "contentType": "<string>", "sizeBytes": 123, "checksum": "<string>", "ingestionStatus": "<string>", "pageCount": 123, "objectId": "<string>", "bates": {}, "metadata": {}, "downloadUrl": "<string>", "expiresIn": 123, "createdAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

API key starting with sk_case_

Path Parameters

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.

Required array length: 1 - 20 elements

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

bates

object

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

Show child attributes

Response

Target object updated successfully

string

vaultId

string

filename

string

contentType

string

sizeBytes

integer

checksum

string

ingestionStatus

string

pageCount

integer

objectId

string

bates

object

metadata

object

downloadUrl

string

expiresIn

integer

createdAt

string<date-time>