ValueApps
Sign inGet started
Developers/API referenceRequest access
Instructions & valuations

Update an instruction

PATCH /api/v1/instructions/INS-2026-0418

Changes the external reference, purpose, property details or the workflow stage. Send only the fields you want to change.

You need an institution key with the instructions:read_write scope. Your administrator makes one in Settings › API access.

Parameters

id
string · required
In the path. The instruction’s reference number.
external_reference
string · optional
Your own reference.
purpose
string · optional
A purpose from your settings.
property.*
object · optional
Any of the property fields shown under Create an instruction.
stage
string · optional
A stage key from your institution’s workflow.

Errors

401 invalid_key
The key is missing, unknown, revoked or expired.
403 ip_not_allowed
The request came from an address the key is not allowed to use.
429 rate_limited
Too many requests this minute. Wait for Retry-After seconds.
429 quota_exceeded
The monthly allowance is used up. It resets on the first of the month.
403 wrong_key
This is a comparables key. Use an institution key for this endpoint.
403 api_not_enabled
API access isn’t switched on for your institution.
403 not_in_plan
This API isn’t part of your institution’s plan. Ask ValueApps to add it.
403 insufficient_scope
The key doesn’t have the access this call needs.
404 not_found
No instruction has that id in your institution.
422 invalid_stage
That stage isn’t one of your institution’s workflow stages.
422 validation_failed
A field is missing or not valid; details names it.