Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Update a participant profile, household association and provider consent.

Update a participant profile, household association and provider consent. Requires participants.write. All writes require Idempotency-Key; x-scope-rules declares additional grants by input condition.

POST/commands/update_participant
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Header parameters
Idempotency-Keystringrequired

Persist with the job and reuse for retries. Scoped to organization, token, command and API version. Different input with the same key returns 409. Supported automatic retry window: 24 hours.

min length 1 · max length 128 · matches ^[!-~]+$
Request body
requiredapplication/json
consent_statusstring
Show properties
Any of:
string
string
string
string
string
string
string
string
date_of_birthstring
display_namestring
external_referencestring
family_namestring
given_namestring
household_idstring

Opaque Soljio resource ID.

min length 1
household_memberobject
Show properties
display_namestring
emailstring
phonestring
relationshipstring
rolestring
Show properties
Any of:
string
string
string
string
string
string
string
string
household_namestring
link_statusstring
Show properties
Any of:
string
string
string
string
notesstring
participant_idstringrequired

Opaque Soljio resource ID.

min length 1
provider_visibilitystring
Show properties
Any of:
string
string
string
string
string
string
statusstring
Show properties
Any of:
string
string
string
string
string
string
Responses
200

Successful command; replay returns the original result.

dataobjectrequired
Show properties
household_idstring

Opaque Soljio resource ID.

min length 1
household_member_idstring

Opaque Soljio resource ID.

min length 1
okbooleanrequired
participant_idstringrequired

Opaque Soljio resource ID.

min length 1
participant_organization_link_idstringrequired

Opaque Soljio resource ID.

min length 1
idempotent_replaybooleanrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/commands/update_participant' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "consent_status": "granted",
  "date_of_birth": "string",
  "display_name": "string",
  "external_reference": "string",
  "family_name": "string",
  "given_name": "string",
  "household_id": "string",
  "household_member": {
    "display_name": "string",
    "email": "string",
    "phone": "string",
    "relationship": "string",
    "role": "guardian"
  },
  "household_name": "string",
  "link_status": "active",
  "notes": "string",
  "participant_id": "string",
  "provider_visibility": "full_profile",
  "status": "active"
}'
Response
{
  "data": {
    "household_id": "string",
    "household_member_id": "string",
    "ok": true,
    "participant_id": "string",
    "participant_organization_link_id": "string"
  },
  "idempotent_replay": true,
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}