Skip to main content
PATCH
Update a request

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

requestId
string<uuid>
required

Query Parameters

owner
string

Tenant owner for machine-to-machine requests

Body

application/json
status
enum<string>
Available options:
pending,
completed,
rejected
filledFields
object[]

A sparse patch of field overrides. Send only the fields you are changing: every (templateId, key) pair here is recorded as an override and from then on wins over the account's own value, and every field you omit is left exactly as it is. An empty string is an override like any other — it renders the field blank, which is how you keep account data off a document.

Send overridden: false to remove an override and hand the field back to the account, so it tracks live data again. Fields with no override are not stored at all; they are resolved from the account on every read, so echoing back values the API served you would freeze them onto the request.

notes
string
priority
integer
triggerContext
object

A single trigger context. Supported for backward compatibility; prefer triggerContexts. Combined with triggerContexts when both are supplied.

triggerContexts
object[]

One or more trigger contexts to (re)resolve templates from. Each adds its matching templates to the request.

owner
string
processingBy
string<uuid>

User ID of the processing user

templateLabelingModes
object[]

Update labeling mode for a specific template instance identified by templateId and templateIndex

Response

Updated request

id
string<uuid>
required
matterId
string
required
owner
string
required
status
enum<string>
required
Available options:
pending,
completed,
rejected
exhibits
object[]
required
templates
object[]
required
state
string
crid
string
priority
integer
createdOn
string<date-time>
updatedAt
string<date-time>
completedBy
string
Minimum string length: 1
completedOn
string<date-time>
rejectedBy
string
Minimum string length: 1
rejectedOn
string<date-time>
processingBy
string
Minimum string length: 1
processingStartedOn
string<date-time>
firmCode
string
deprecated

Deprecated: use firmId going forward. The snapshotted service firm code for the firm handling this matter, taken at creation time.

firmId
string

The snapshotted service firm UUID for the firm handling this matter, taken at creation time.

workflowStatus
enum<string>

Where the document has reached across the whole workflow, which carries on after the request's own status is completed. A document is done once it has been both signed and reviewed, and workflows run those two steps in either order, so this is derived from those two facts rather than from a position in a sequence.

Available options:
draft,
prepared,
awaiting_signature,
wet_ink_pending,
awaiting_qc,
qc_rejected,
signature_rejected,
completed,
rejected
signatureRequestId
string<uuid>

The signature request raised for this file request, once one exists. Use it with GET /v2/requests/{signatureRequestId} on the Signatures API.

qualityCheckRequestId
string<uuid>

The quality check request raised for this file request, once one exists. Use it with GET /v2/qc/requests/{qcrID} on the Quality Control API.

signedFileId
string<uuid>

The signed document saved to the CRID, once Slate has created it. Its presence alone does not mean the workflow finished — read workflowStatus for that.

signedOn
string<date-time>

When the document was signed, by whichever route: an e-signature ceremony completing, a wet-ink mark where QC comes before signing, or a signed wet-ink scan being uploaded where QC comes after signing.

qcApprovedOn
string<date-time>

When quality control approved the document.

requestedFields
object[]
filledFields
object[]

The effective value of every template field, resolved when the request is read: an override if one was set, otherwise the account's current value, otherwise the template's default. This is what the generated document will render.

generatedFile
object
notes
string