# Create a DigitalForm

`POST /v1/digital_forms`

Creates a DigitalForm and its questions. Choice questions can include nested choices. Requires `digital_forms.create`.

**Required API scopes:** `digital_forms.create`

## Parameters

- `Idempotency-Key` (header, `string`) (required) - Client-generated idempotency key. Required for every POST/PATCH write. Replay of the same key with the same body returns the stored response with an `Idempotency-Replayed: true` header. Same key + different body returns `422 idempotency_key_reused`. A duplicate that arrives while the first request is still in flight returns `409 idempotency_conflict` with `Retry-After: 1`.

## Request body (`application/json`)

- `object`
  - `patient_instructions` (`string | null`) - The instructions shown to the Patient with the DigitalForm.
  - `questions` (`array`) - The ordered questions to include on the DigitalForm.
    - `items` (`object`)
      - `choices` (`array`) - The choices for a `single_choice_input` or `multiple_choice_input` question.
        - `items` (`object`)
          - `list_order_number` (`integer`) - The position of the choice. Defaults to the array index plus one.
          - `numerical_value` (`number | null`) - The optional numerical value assigned to the choice.
          - `text_value` (`string | null`) - The optional machine-readable text value assigned to the choice.
          - `title` (`string`) - The choice shown to the Patient.
      - `help_text` (`string | null`) - The supplementary guidance shown with the question.
      - `is_answer_required` (`boolean`) - Whether the Patient must answer the question. Consent questions are always required.
      - `list_order_number` (`integer`) - The position of the question. Defaults to the array index plus one.
      - `question_type` (`string`) - enum: `consent_required`, `information_statement`, `multiple_choice_input`, `single_choice_input`, `text_input`, `number_input`, `date_input`, `signature_input`; The input and consent behavior of the question.
      - `title` (`string`) - The question shown to the Patient.
  - `title` (`string`) - The title of the DigitalForm.

### Example

```json
{
  "patient_instructions": "Please complete this form before your appointment.",
  "questions": [
    {
      "question_type": "consent_required",
      "title": "Do you consent to treatment?"
    },
    {
      "choices": [
        {
          "text_value": "gp",
          "title": "GP referral"
        },
        {
          "text_value": "search",
          "title": "Search"
        }
      ],
      "question_type": "single_choice_input",
      "title": "How did you hear about us?"
    }
  ],
  "title": "Pre-appointment questionnaire"
}
```

## Response `201`

The requested `DigitalForm`.

- `object`
  - `attachment_url` (`string | null`) - format: `uri`; The temporary URL for the attachment displayed with the DigitalForm.
  - `created_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.
  - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - `object` (`any`) - Discriminator value emitted at `object`.
  - `patient_instructions` (`string | null`) - The sanitized instructions shown to the Patient.
  - `questions` (`array`) - The ordered questions included in the DigitalForm.
    - `items` (`object`) - A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
      - `choices` (`array`) - The choices available for a choice question.
        - `items` (`object`)
          - `id` (`string`) - format: `uuid`; The identifier of the DigitalFormQuestionChoice.
          - `numerical_value` (`number | null`) - The optional numerical value assigned to the choice.
          - `text_value` (`string | null`) - The optional machine-readable text value assigned to the choice.
          - `title` (`string`) - The choice shown to the Patient.
      - `help_text` (`string | null`) - The supplementary guidance shown with the question.
      - `id` (`string`) - format: `uuid`; The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - `is_answer_required` (`boolean`) - Whether the Patient must answer the question.
      - `list_order_number` (`integer | null`) - The position of the question in the DigitalForm.
      - `question_type` (`string`) - enum: `consent_required`, `information_statement`, `multiple_choice_input`, `single_choice_input`, `text_input`, `number_input`, `date_input`, `signature_input`; The input and consent behavior of the question.
      - `title` (`string`) - The question shown to the Patient.
  - `title` (`string`) - The title of the DigitalForm.
  - `updated_at` (`string`) - format: `date-time`; An ISO 8601 timestamp in UTC, with a `Z` suffix. For example, `2026-07-01T09:00:00Z`.

### Example

```json
{
  "id": "00000000-0000-4000-8000-000000000020",
  "object": "digital_form",
  "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
  "created_at": "2026-01-01T09:00:00Z",
  "patient_instructions": "Please complete this form before your appointment.",
  "questions": [
    {
      "id": "2214b284-64d6-4130-8b10-1602a2050126",
      "choices": [
        {
          "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
          "numerical_value": 1.5,
          "text_value": "yes",
          "title": "Dr"
        }
      ],
      "help_text": "Select every option that applies.",
      "is_answer_required": true,
      "list_order_number": 1,
      "question_type": "consent_required",
      "title": "Dr"
    }
  ],
  "title": "Dr",
  "updated_at": "2026-01-01T09:00:00Z"
}
```

## Response `400`

The `Idempotency-Key` header is missing (`idempotency_key_required`) or exceeds 255 characters (`idempotency_key_too_long`).

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Response `401`

The access token is missing, invalid, expired, or revoked.

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Response `403`

The access token lacks the required scope, or the project is disabled.

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Response `409`

A concurrent request holds the idempotency lease (`idempotency_conflict`). Retry after the delay indicated by `Retry-After`.

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Response `422`

The DigitalForm cannot be created. `title` is required, and each question requires `title` and `question_type`.

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Response `429`

Too many requests. Retry after the delay indicated by `Retry-After`.

- `object`
  - `error` (`object`) - The structured details that describe why the request failed.
    - `code` (`string`) - The machine-readable error code.
    - `errors` (`array | null`) - Additional errors from a failed validation.
      - `items` (`object`)
        - `code` (`string`) - The machine-readable code for this validation error.
        - `message` (`string`) - A message that explains this validation error.
        - `param` (`string | null`) - The name of the parameter that caused this validation error, when known.
    - `message` (`string`) - A message that explains the error and how to resolve it.
    - `param` (`string | null`) - The name of the parameter that caused the error, when known.
    - `type` (`string`) - enum: `authentication_error`, `permission_error`, `invalid_request_error`, `rate_limit_error`, `api_error`; The high-level category of the error.

### Example

```json
{
  "error": {
    "code": "resource_missing",
    "errors": [
      {
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}
```

## Code samples

```bash
curl -X POST "https://api.carebit.co/v1/digital_forms" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "patient_instructions": "Please complete this form before your appointment.",
  "questions": [
    {
      "question_type": "consent_required",
      "title": "Do you consent to treatment?"
    },
    {
      "choices": [
        {
          "text_value": "gp",
          "title": "GP referral"
        },
        {
          "text_value": "search",
          "title": "Search"
        }
      ],
      "question_type": "single_choice_input",
      "title": "How did you hear about us?"
    }
  ],
  "title": "Pre-appointment questionnaire"
}'
```

```javascript
const response = await fetch("https://api.carebit.co/v1/digital_forms", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CAREBIT_ACCESS_TOKEN}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
  "patient_instructions": "Please complete this form before your appointment.",
  "questions": [
    {
      "question_type": "consent_required",
      "title": "Do you consent to treatment?"
    },
    {
      "choices": [
        {
          "text_value": "gp",
          "title": "GP referral"
        },
        {
          "text_value": "search",
          "title": "Search"
        }
      ],
      "question_type": "single_choice_input",
      "title": "How did you hear about us?"
    }
  ],
  "title": "Pre-appointment questionnaire"
}),
});

if (!response.ok) {
  throw new Error(`Carebit API error: ${response.status}`);
}

const data = await response.json();
```

```python
import os
import requests
import uuid

response = requests.post(
    "https://api.carebit.co/v1/digital_forms",
    headers={
        "Authorization": f"Bearer {os.environ['CAREBIT_ACCESS_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "patient_instructions": "Please complete this form before your appointment.",
        "questions": [
            {
                "question_type": "consent_required",
                "title": "Do you consent to treatment?"
            },
            {
                "choices": [
                    {
                        "text_value": "gp",
                        "title": "GP referral"
                    },
                    {
                        "text_value": "search",
                        "title": "Search"
                    }
                ],
                "question_type": "single_choice_input",
                "title": "How did you hear about us?"
            }
        ],
        "title": "Pre-appointment questionnaire"
    }
)
response.raise_for_status()
data = response.json()
```

```ruby
require "httparty"
require "json"
require "securerandom"

response = HTTParty.post(
  "https://api.carebit.co/v1/digital_forms",
  headers: {
    "Authorization" => "Bearer #{ENV.fetch("CAREBIT_ACCESS_TOKEN")}",
    "Idempotency-Key" => SecureRandom.uuid,
    "Content-Type" => "application/json"
  },
  body: {
    "patient_instructions" => "Please complete this form before your appointment.",
    "questions" => [
      {
        "question_type" => "consent_required",
        "title" => "Do you consent to treatment?"
      },
      {
        "choices" => [
          {
            "text_value" => "gp",
            "title" => "GP referral"
          },
          {
            "text_value" => "search",
            "title" => "Search"
          }
        ],
        "question_type" => "single_choice_input",
        "title" => "How did you hear about us?"
      }
    ],
    "title" => "Pre-appointment questionnaire"
  }.to_json
)
raise "Carebit API error: #{response.code}" unless response.success?
data = response.parsed_response
```

```php
<?php

$client = new GuzzleHttp\Client();

$response = $client->post("https://api.carebit.co/v1/digital_forms", [
    "headers" => [
      "Authorization" => "Bearer " . getenv("CAREBIT_ACCESS_TOKEN"),
      "Idempotency-Key" => bin2hex(random_bytes(16)),
    ],
    "json" => [
      "patient_instructions" => "Please complete this form before your appointment.",
      "questions" => [
        [
          "question_type" => "consent_required",
          "title" => "Do you consent to treatment?"
        ],
        [
          "choices" => [
            [
              "text_value" => "gp",
              "title" => "GP referral"
            ],
            [
              "text_value" => "search",
              "title" => "Search"
            ]
          ],
          "question_type" => "single_choice_input",
          "title" => "How did you hear about us?"
        ]
      ],
      "title" => "Pre-appointment questionnaire"
    ]
]);
$data = json_decode((string) $response->getBody(), true, flags: JSON_THROW_ON_ERROR);
```