Skip to main content

Endpoint

PATCH /api/v1/bras/{bra_id}

Description

Updates BRA metadata. Only available for BRAs in draft or in_progress status.

Path Parameters

ParameterTypeRequiredDescription
bra_idUUIDYesBRA identifier

Request Body

{
  "name": "Q1 2026 Retail Banking Assessment (Updated)",
  "description": "Updated description",
  "period": "Q1-Q2 2026",
  "assessor": "Jane Doe"
}
FieldTypeRequiredDescription
namestringNoUpdated BRA name
descriptionstringNoUpdated description
periodstringNoUpdated period
assessorstringNoUpdated assessor

Response

{
  "data": {
    "id": "bra-uuid-001",
    "name": "Q1 2026 Retail Banking Assessment (Updated)",
    "description": "Updated description",
    "status": "in_progress",
    "period": "Q1-Q2 2026",
    "assessor": "Jane Doe",
    "updated_at": "2026-01-15T15:30:00Z"
  },
  "message": "BRA updated successfully"
}

Example Request

curl -X PATCH "https://api.risklegion.com/api/v1/bras/bra-uuid-001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 2026 Retail Banking Assessment (Updated)"
  }'

Validation Rules

  • Cannot update BRAs with status approved or cancelled
  • legal_entity_id cannot be changed after creation
  • Assessors can only update BRAs they created