# Create a form completion request

Operation ID: `connectors.healthieCreateFormCompletionRequest`

Create a form completion request. recipient_ids: comma-separated User IDs. form_id: ID of the form template. For recurring: set is_recurring=true, frequency ("Daily"/"Weekly"/"Monthly"), etc.

## Public method

`createFormCompletionRequest`

Signature: `connectors.healthie.createClient(config).createFormCompletionRequest(body)`

Return type: `Promise<HealthieFormResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/healthie/create-form-completion-request`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "api_url": "https://example.com/resource",
  "form_id": "12345",
  "is_recurring": true,
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "recipient_ids": "example-recipient-ids",
  "secret_key": "example-api-key",
  "shard_id": "12345"
}
```

## Success responses

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

## Success response examples

### 200

```json
{
  "id": "12345",
  "item_type": "example-item-type",
  "status": "example-status"
}
```

## 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 { HealthieCreateFormCompletionRequestRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_url": "https://example.com/resource",
  "form_id": "12345",
  "is_recurring": true,
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "recipient_ids": "example-recipient-ids",
  "secret_key": "example-api-key",
  "shard_id": "12345"
};

const result = await connectors.healthie.createClient(config).createFormCompletionRequest(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_url":"https://example.com/resource","form_id":"12345","is_recurring":true,"mode":"sandbox","open_loop_url":"https://example.com/resource","recipient_ids":"example-recipient-ids","secret_key":"example-api-key","shard_id":"12345"}' \
  'https://dev-api-connectors.health.cloud/connectors/healthie/create-form-completion-request'
```

## 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.