Update a risk assessment
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
client_uuid
string Required -
uuid
integer Required
Body
-
level
integer The risk level of the clients risk assessment. Number between 1 and 1,000. Cannot be set with level_string
-
level_string
string The risk level of the client as a string/text. Cannot be set with level.
-
completed_at
date Date of risk assessment completion.
-
completed_by
string Uuid of the employee that completed the risk assessment
-
risk_assessment_provider
string Name of provider for the risk assessment
-
time_horizon
string Time horizon: how long the risk assessment will last for the client.
PUT
/api/v1/client/{client_uuid}/risk/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/client/client_uuid/risk/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"level":7,"level_string":"Moderately Aggressive","completed_at":"2024-04-02T13:27:55+01:00","completed_by":"97e4902e-cf5d-44c2-85f5-a9a214a403d2","risk_assessment_provider":"Defaqto","time_horizon":"For the next 5 years"}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"level": 7,
"level_string": "Moderately Aggressive",
"completed_at": "2024-04-02T13:27:55+01:00",
"completed_by": "97e4902e-cf5d-44c2-85f5-a9a214a403d2",
"risk_assessment_provider": "Defaqto",
"time_horizon": "For the next 5 years"
}
Response examples (200)
{
"uuid": "8de998bb-379f-4e87-8c9d-ffef9f700a78",
"level": 52,
"created_at": "2025-04-02T13:27:55+01:00",
"updated_at": "2025-04-02T13:27:55+01:00",
"completed_at": "2024-04-02T13:27:55+01:00",
"completed_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "c3d7c9f3-8d8a-453e-a867-acde97231c21",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:55+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:55+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-04-02T13:27:55+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:55+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-04-02T13:27:55+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:55+01:00"
},
"level_string": "Moderately Aggressive",
"time_horizon": "For the next 5 years",
"time_horizon_set_at": "2025-03-02T13:27:55+00:00",
"risk_assessment_provider": "Defaqto"
}