Skip to main content
PUT
Update an existing assessment. Supports optimistic locking via version number.

Path parameters

string
required
Assessment ID (UUID).

Request body

All fields are optional. Only provided fields will be updated.
string
Assessment name or identifier.Maximum length: 200 characters.
string
Name of the company being assessed.Maximum length: 200 characters.
string
Type or category of company.Maximum length: 100 characters.
string
Update the assessment status.Allowed values: DRAFT, ANALYZING, ACTION_REQUIRED, COMPLETE
number
Update completion percentage.Range: 0-100
number
Current version number for optimistic locking.If provided, the update will only succeed if the current database version matches this value. This prevents concurrent updates from overwriting each other. If the version doesn’t match, a 409 Conflict error is returned.The version is automatically incremented on each update.

Response

Returns the updated assessment object with all fields.
string
Unique assessment identifier (UUID).
string
Assessment name.
string
Company name.
string
Company type.
string
Country of operation.
string
Current status: DRAFT, ANALYZING, ACTION_REQUIRED, or COMPLETE
string
Data collection method: UPLOAD, GUIDED_INTERVIEW, or MANUAL_ENTRY
number
Completion percentage (0-100).
number
Version number (incremented on each update).
number
Aggregated risk score (0-100). Null until complete.
string
Risk classification: LOW, MODERATE, HIGH, or CRITICAL. Null until complete.
string
Creator user ID.
string
ISO 8601 creation timestamp.
string
ISO 8601 last update timestamp.

Optimistic locking workflow

To prevent concurrent updates from conflicting:
1

Fetch current assessment

GET the assessment to retrieve the current version number.
2

Make changes

Modify the assessment data in your application.
3

Submit update with version

Include the version field in your PUT request body.
4

Handle conflicts

If you receive a 409 Conflict response, refresh the assessment data and ask the user to re-apply their changes.
Omitting the version field disables optimistic locking. The update will always succeed (unless the assessment doesn’t exist), but you risk overwriting concurrent changes.