Update a member's profile progress

PUT /api/members/{memberId}/profile-progress

Overview

Records how complete a member considers their profile to be, as a single percentage. It is a display value that your application owns: the platform stores the number you send and never calculates or adjusts it, so nothing else in Gladstone will move it when the member fills in a field elsewhere.

The value is stored on a profile-data record attached to the member. If the member has no such record yet, one is created on the first call, so you do not need to initialise anything.

Each call overwrites the previous percentage outright; there is no history, and the value can go down as well as up.

Linked members are permitted — a token issued for a member linked to {memberId} may call this endpoint.

Endpoint

PUT {base_url}/api/members/{memberId}/profile-progress

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

NameTypeRequiredDescription
memberIdinteger (int32)YesThe member whose profile progress is recorded. Must match the member id in your access token, or be a member linked to it.

Request body

FieldTypeRequiredDescription
completedPercentageinteger (int32)YesHow complete the profile is, as a whole number from 0 to 100 inclusive. Anything outside that range, a non-integer, or a missing value is rejected with 400. Send 0 to reset the indicator — omitting the field is not the same thing and fails validation. The meaning of the number is entirely yours; the platform does not derive it from any profile field.

Sample request

cURL
curl -X PUT '{base_url}/api/members/{memberId}/profile-progress' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '{
  "completedPercentage": 1
}'

Errors

A successful call returns 204 No Content.

StatusMeaningWhen
400Bad requestcompletedPercentage is missing, or outside 0–100. Returned as a model-state object rather than a plain string.
404Not foundNo member exists with that id: {memberId} is an invalid member ID
500Internal server errorSaving the change failed, or another unexpected server-side failure occurred. No detail is returned in the body.

This page as markdown · All pages · llms.txt