Skip to main content
PUT
Update Document

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

name
string
category
string
status
string
type
string
fileUrl
string
fileSize
number | null
mimeType
string
fileSignature
string
folderId
string
created
string
updated
string
receivedDate
string
requiresSignature
boolean
isSigned
boolean
signedBy
object[] | null
signedDate
string
isActive
boolean
loanId
string | null
borrowerId
string | null
propertyId
string | null
transactionId
string | null
userId
string | null

Response

Response for status 200

id
string
required
name
string

Present unless the request's fields leaves it out.

category
string

Present unless the request's fields leaves it out.

status
string

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

fileUrl
string | null

Present unless the request's fields leaves it out.

fileSize
number | null

Present unless the request's fields leaves it out.

mimeType
string

Present unless the request's fields leaves it out.

fileSignature
string

Present unless the request's fields leaves it out.

folderId
string

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

receivedDate
string | null

Present unless the request's fields leaves it out.

requiresSignature
boolean

Present unless the request's fields leaves it out.

isSigned
boolean

Present unless the request's fields leaves it out.

signedBy
object[] | null

Present unless the request's fields leaves it out.

signedDate
string | null

Present unless the request's fields leaves it out.

isActive
boolean

Present unless the request's fields leaves it out.

loanId
string | null

Present unless the request's fields leaves it out.

borrowerId
string | null

Present unless the request's fields leaves it out.

propertyId
string | null

Present unless the request's fields leaves it out.

transactionId
string | null

Present unless the request's fields leaves it out.

userId
string | null

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.