> ## Documentation Index > Fetch the complete documentation index at: https://api.vitarelay.com/llms.txt > Use this file to discover all available pages before exploring further. # Submit referral intake answers (you collect them) > Submit intake answers your patient completed on YOUR OWN site. Creates a submitted intake and automatically routes the referral to the Internal Doctor Network — no hosted intake link needed. Use this instead of [Send a referral intake link](/api-reference/intakes/send-a-referral-intake-link) when you collect the questionnaire yourself. The IDN prescriber still reviews and writes or declines the script. Requires `rx:write` (a key with `intakes:write` also works). Vita Clinics use [Submit intake answers](/api-reference/intakes/submit-intake-answers-you-collect-them). The body accepts only `responses`, `pharmacy_product_id` and `external_intake_id`; any other field returns `400 validation_failed`. Test keys run in a full sandbox (no real records created). ## OpenAPI ````yaml /openapi.yaml post /rx/patients/{patientId}/intake/submit openapi: 3.1.0 info: title: VitaRelay API version: 2.0.0 description: | The VitaRelay REST API. **Base URL:** `https://vitarelay.com/api/public/v1` ## Authentication All requests require a Bearer API key: ```text Authorization: Bearer vr_live_xxxxxxxxxxxxxxxx ``` Keys are issued per organization. `vr_live_` keys act on production data. `vr_test_` keys operate a fully-isolated **sandbox** (see below). ## Pagination List endpoints are cursor-based. Pass `limit` (default 50, max 100) and `cursor` (the `next_cursor` from the previous page). When `next_cursor` is `null` there are no further pages. All resource ids are UUIDs. ## Idempotency Write endpoints accept your own external identifiers — `external_patient_id`, `external_intake_id`, `external_order_id`. These act as idempotency keys: replaying a request with the same external id returns the original resource (HTTP `200` instead of `201`) rather than creating a duplicate. ## Rate limiting Write endpoints are rate limited per API key — default **60 requests per minute** (fixed window). Exceeding the limit returns `429 rate_limited` with `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers. Read endpoints are not rate limited in v1. ## Sandbox With a `vr_test_` key, writes never create real patients, intakes or orders and never charge a card. They return synthetic ids (`sandbox_pat_…`, `sandbox_int_…`, `sandbox_ord_…`) and include `"sandbox": true` in the response. Sandbox objects advance through a simulated lifecycle that fires real webhook deliveries to your endpoint (`intake.reviewed`, `order.paid` → `order.shipped` → `order.delivered`) with `"sandbox": true` in the payload. In sandbox, reference a patient by `external_patient_id` or by the returned `sandbox_pat_…` id. ## Webhooks Outbound webhooks are configured in the VitaRelay admin UI (there is no webhook management API). Events: `order.paid`, `order.shipped`, `order.delivered`, `order.exception`, `intake.reviewed`. Each delivery is signed with HMAC-SHA256 over the raw body and carries the headers `X-VitaRelay-Signature: sha256=`, `X-VitaRelay-Event`, `X-VitaRelay-Delivery` (event id) and `X-VitaRelay-Timestamp`. Failed deliveries are retried with exponential backoff and dead-lettered after the maximum attempts. contact: name: VitaRelay Support email: info@vitarelay.com servers: - url: https://vitarelay.com/api/public/v1 description: Production security: - bearerAuth: [] tags: - name: Patients description: Patient records scoped to your organization. - name: Intakes description: >- The health questionnaire a prescriber reviews. There are two ways to complete one, and each has a Vita Clinic endpoint and a referral (Rx) endpoint. **Patient fills it in on our page:** `POST /patients/{patientId}/intake/send-link` (Vita Clinic) or `POST /rx/patients/{patientId}/intake` (referral). **You collect the answers and send them to us:** `POST /intakes` (Vita Clinic) or `POST /rx/patients/{patientId}/intake/submit` (referral). Check progress with `GET /patients/{patientId}/intake/status` and the `intake.submitted` / `intake.reviewed` webhooks. See [Intakes and prescriber review](/getting-started/intakes-and-prescriptions) and the [Intake answers reference](/getting-started/intake-responses). - name: Orders description: >- Orders and fulfillment status. Two billing modes: `card_on_file` (default) charges the clinic's stored card synchronously, and `patient_checkout` creates the order unpaid and returns a checkout block so the patient can pay on your own page via Authorize.Net Accept.js (see POST /orders/{id}/pay). - name: Products description: Catalog products available to your organization. - name: Prescriptions description: >- Prescriptions written by your organization (read only). Refer patients into the Internal Doctor Network (IDN). You refer; an IDN doctor evaluates and prescribes. Requires IDN activation and rx scopes. - name: Storefront description: >- Build and manage your clinic's patient storefront — settings, curated product listings and bundles. Requires the `shop:read` / `shop:write` scopes. - name: Subscriptions description: >- Patient-shop subscription lifecycle. Requires `subscriptions:read` or `subscriptions:write`. - name: Partners description: >- Consultant (partner) program. **Available only to organizations enrolled in the program; every other organization receives `403 not_available`.** Create your consultants, assign customers to them and read the commission credit tracked on their orders. Requires `partners:read` / `partners:write`. Commissions are tracked for your own payouts — VitaRelay does not pay consultants. paths: /rx/patients/{patientId}/intake/submit: post: tags: - Intakes summary: Submit referral intake answers (you collect them) description: >- Submit intake answers your patient completed on YOUR OWN site. Creates a submitted intake and automatically routes the referral to the Internal Doctor Network — no hosted intake link needed. Use this instead of [Send a referral intake link](/api-reference/intakes/send-a-referral-intake-link) when you collect the questionnaire yourself. The IDN prescriber still reviews and writes or declines the script. Requires `rx:write` (a key with `intakes:write` also works). Vita Clinics use [Submit intake answers](/api-reference/intakes/submit-intake-answers-you-collect-them). The body accepts only `responses`, `pharmacy_product_id` and `external_intake_id`; any other field returns `400 validation_failed`. Test keys run in a full sandbox (no real records created). parameters: - name: patientId in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: object required: - responses properties: responses: allOf: - $ref: '#/components/schemas/IntakeRequiredAnswers' description: >- The questionnaire answers. The six required fields must be present or the request is rejected `422`. Send the rest of the questionnaire too, using the keys in the [Intake answers reference](/getting-started/intake-responses). pharmacy_product_id: type: string description: >- Optional. The requested 503A product id (from /rx/catalog). The prescriber still decides. external_intake_id: type: string description: Optional idempotency key. example: responses: treatment_need: - weight loss treatment_reason: Patient seeking GLP-1 therapy for weight management current_meds: none has_allergies: 'no' attest_accurate: true attest_telehealth: true pharmacy_product_id: 063b65ad-d92a-4120-9784-869f21f9c3ea responses: '201': description: Intake submitted and routed to the IDN. content: application/json: schema: type: object properties: data: type: object properties: intake_id: type: string status: type: string pushed_to_idn: type: boolean '400': $ref: '#/components/responses/InvalidBody' '403': $ref: '#/components/responses/IdnNotJoined' '404': $ref: '#/components/responses/RxNotFound' '422': description: Intake incomplete — `message` lists the missing required answers. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: IntakeRequiredAnswers: type: object additionalProperties: true required: - treatment_need - treatment_reason - current_meds - has_allergies - attest_accurate - attest_telehealth properties: treatment_need: description: Primary treatment goal. An array of strings, or a non-empty string. oneOf: - type: array minItems: 1 items: type: string - type: string minLength: 1 example: - weight_loss treatment_reason: type: string minLength: 1 description: Why the patient wants treatment. Non-empty. current_meds: description: >- Current medications. Required to be present; `""` or `"none"` are valid answers. example: none has_allergies: description: Allergies answer. Required to be present; `"no"` is a valid answer. example: 'no' attest_accurate: type: boolean enum: - true description: Must be the boolean `true`. attest_telehealth: type: boolean enum: - true description: Must be the boolean `true` (telehealth consent). Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: | One of `invalid_body`, `validation_failed`, `unauthorized`, `insufficient_scope`, `not_vita_clinic`, `patient_not_found`, `product_not_found`, `product_not_allowed`, `duplicate_request`, `rate_limited`, `card_required`, `payment_declined`, `internal_error`, `not_found`. message: type: string example: error: code: validation_failed message: One or more fields are invalid RxError: type: object properties: error: type: object properties: code: type: string message: type: string responses: InvalidBody: description: >- Malformed request or invalid path parameter (`invalid_body`, `invalid_id`). content: application/json: schema: $ref: '#/components/schemas/Error' IdnNotJoined: description: Org not IDN-activated, or rx scope missing. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: idn_not_joined message: Your organization hasn't joined the Internal Doctor Network yet. RxNotFound: description: Patient/request not found for your org. content: application/json: schema: $ref: '#/components/schemas/RxError' securitySchemes: bearerAuth: type: http scheme: bearer description: | API key issued by VitaRelay. Send as `Authorization: Bearer vr_live_…` (production) or `Authorization: Bearer vr_test_…` (sandbox). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.