# Update consult status

Operation ID: `connectors.steadymdUpdateConsultStatus`

POST /v1/consult/{guid}/status — Update consult status.

## Public method

`updateConsultStatus`

Signature: `connectors.steadymd.createClient(config).updateConsultStatus(body)`

Return type: `Promise<SteadyMDUpdateConsultStatusResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/steadymd/update-consult-status`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`SteadyMDUpdateConsultStatusRequest`](../models/SteadyMDUpdateConsultStatusRequest.md) | Yes |  |  |  | No |  |

Request model: [`SteadyMDUpdateConsultStatusRequest`](../models/SteadyMDUpdateConsultStatusRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "api_url": "https://example.com/resource",
  "consult_guid": "example-consult-guid",
  "mode": "sandbox"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`SteadyMDConsult`](../models/SteadyMDConsult.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "appointment_ends_at": "example-appointment-ends-at",
  "appointment_ends_at_local_time": "example-appointment-ends-at-local-time",
  "appointment_scheduled_ends_at": "example-appointment-scheduled-ends-at",
  "appointment_scheduled_starts_at": "example-appointment-scheduled-starts-at",
  "appointment_starts_at": "example-appointment-starts-at",
  "appointment_starts_at_local_time": "example-appointment-starts-at-local-time",
  "appointment_timezone": "example-appointment-timezone",
  "clinician": "example-clinician",
  "clinician_guid": "example-clinician-guid",
  "consult_definition_guid": "example-consult-definition-guid",
  "consult_type": "example-consult-type",
  "created_at": "example-created-at",
  "emr_uri": "example-emr-uri",
  "episode_guid": "example-episode-guid",
  "external_links": [],
  "guid": "example-guid",
  "is_external": true,
  "is_high_priority": true,
  "is_pediatric": true,
  "is_scheduled": true,
  "preferred_clinician": "example-preferred-clinician",
  "preferred_clinician_guid": "example-preferred-clinician-guid",
  "program_display_name": "Example Name",
  "program_guid": "example-program-guid",
  "program_name": "Example Name",
  "reason": "example-reason",
  "reason_for_visit": "example-reason-for-visit",
  "reason_slug": "example-reason-slug",
  "us_state": "MA",
  "visit_status": "example-visit-status",
  "visit_status_set_at": "example-visit-status-set-at"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { SteadyMDUpdateConsultStatusRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "api_url": "https://example.com/resource",
  "consult_guid": "example-consult-guid",
  "mode": "sandbox"
};

const result = await connectors.steadymd.createClient(config).updateConsultStatus(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","api_url":"https://example.com/resource","consult_guid":"example-consult-guid","mode":"sandbox"}' \
  'https://dev-api-connectors.health.cloud/connectors/steadymd/update-consult-status'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.