---
search:
  tags:
    - organization-commands
    - POST
seo:
  description: >-
    Update a participant profile, household association and provider… Reference
    for the POST /commands/update_participant endpoint in the Soljio
    Organization API.
sidebar:
  label: Update a participant profile, household association and provider consent.
  badge: POST
title: Update a participant profile, household association and provider consent.
type: openapi-operation
---
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`

**Request body** (`application/json`, required)

- `consent_status` (string)
- `date_of_birth` (string)
- `display_name` (string)
- `external_reference` (string)
- `family_name` (string)
- `given_name` (string)
- `household_id` (string) — Opaque Soljio resource ID.
- `household_member` (object)
- `household_name` (string)
- `link_status` (string)
- `notes` (string)
- `participant_id` (string, required) — Opaque Soljio resource ID.
- `provider_visibility` (string)
- `status` (string)

Request body example:

```json
{
  "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"
}
```

**Responses**

- `200` — Successful command; replay returns the original result.
- `400` — invalid\_request
- `401` — unauthorized
- `403` — forbidden
- `404` — not\_found
- `405` — method\_not\_allowed
- `409` — conflict, idempotency\_conflict
- `413` — payload\_too\_large
- `415` — unsupported\_media\_type
- `429` — rate\_limited
- `500` — internal\_error

Response example, 200:

```json
{
  "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"
}
```

Response example, 400:

```json
{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 401:

```json
{
  "error": {
    "code": "unauthorized",
    "message": "A valid service token is required."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 403:

```json
{
  "error": {
    "code": "forbidden",
    "message": "The service token lacks a required scope."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 404:

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 405:

```json
{
  "error": {
    "code": "method_not_allowed",
    "message": "The method is not supported for this resource."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 409:

```json
{
  "error": {
    "code": "conflict",
    "message": "The command conflicts with the current state."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 413:

```json
{
  "error": {
    "code": "payload_too_large",
    "message": "The request body exceeds the byte limit for this operation."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 415:

```json
{
  "error": {
    "code": "unsupported_media_type",
    "message": "Use application/json for command requests."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 429:

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the indicated delay."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```

Response example, 500:

```json
{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed."
  },
  "request_id": "00000000-0000-4000-8000-000000000001"
}
```
