Skip to main content
PATCH
Update Request

Permissions

Requires Intake API permission, and Intake access or Intake admin permission. If these permissions are not available to select, contact support@harvey.ai.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

request_id
string<uuid>
required

The unique identifier of the intake request, as returned when it was submitted.

Body

application/json

The fields to change on an intake request.

title
string

The new title. Surrounding whitespace is removed, and it cannot be null or blank.

Required string length: 1 - 255
Example:

"Review the Northwind master services agreement"

description
string | null

The new description as plain text. Send null to remove it.

Maximum string length: 10000
status
enum<string>

Lifecycle state of an intake request.

Available options:
TODO,
IN_PROGRESS,
READY_FOR_REVIEW,
DONE,
CANCELLED
due_at
string<date> | null

The new due date as YYYY-MM-DD. Send null to remove it.

Example:

"2027-01-01"

Response

The intake request after the update. A body that changes nothing also returns 200.

request_id
string<uuid>

The unique identifier of the intake request.

status
enum<string>

Lifecycle state of an intake request.

Available options:
TODO,
IN_PROGRESS,
READY_FOR_REVIEW,
DONE,
CANCELLED
harvey_url
string

Deep link to the request in Harvey.

title
string | null

The request's title.

description
string | null

The request's description.

created_at
string<date-time>

When the request was submitted.

updated_at
string<date-time>

When the request last changed.

completed_at
string<date-time> | null

When the request reached DONE.

due_at
string<date> | null

The date the request is due.

assignee
object | null

Who is working the request.

attachments
object[]

Files submitted with the request.