v1

latestOpenAPI 3.0.02026-07-231358118.3 KB

IntakeForms

Create a new intake form

Creates a new intake form in the HealthSherpa system. The intake form will be associated with the authenticated agent. All intake forms must have at least one of: first name, last name, email, or phone_number. This endpoint also supports creating nested resources for household income and members. Optional prescriptions and providers fields may be included on the request. These values are not stored on the intake form record or in persisted intake_info. They are used only to populate the public shop (plan shopping) deeplink returned as shopping_url when the agent is eligible for deeplinking. They do not affect client_apply_url or any other persisted fields.

post/intake_forms

Request body

user_uploaded_note_contentstring nullable

Agent note for the client

first_namestring nullable

First name of the client. At least one of first_name, last_name, email, or phone_number is required.

last_namestring nullable

Last name of the client. At least one of first_name, last_name, email, or phone_number is required.

external_idstring nullable

An external reference or integration id for this intake (optional).

emailstring email nullable

Email address of the client. At least one of first_name, last_name, email, or phone_number is required.

phone_numberstring nullable

Phone number of the client. At least one of first_name, last_name, email, or phone_number is required.

someone_has_employer_coverageboolean nullable

Whether a member has employer coverage

addressstring nullable

Street address

address_2string nullable

Apartment or secondary address line

citystring nullable

City name

statestring nullable

USPS state abbreviation such as AZ and FL

zipstring nullable

ZIP or postal code

dry_runboolean nullable

Whether the API call should commit the requested changes. If dry_run is set to true, you'll get the same response body as if the intake form was created or edited. We will not actually persist the data.

Response

Intake form created successfully.

user_uploaded_note_contentstring nullable

Agent note for the client

first_namestring nullable

First name of the client. At least one of first_name, last_name, email, or phone_number is required.

last_namestring nullable

Last name of the client. At least one of first_name, last_name, email, or phone_number is required.

external_idstring nullable

An external reference or integration id for this intake (optional).

emailstring email nullable

Email address of the client. At least one of first_name, last_name, email, or phone_number is required.

phone_numberstring nullable

Phone number of the client. At least one of first_name, last_name, email, or phone_number is required.

someone_has_employer_coverageboolean nullable

Whether a member has employer coverage

addressstring nullable

Street address

address_2string nullable

Apartment or secondary address line

citystring nullable

City name

statestring nullable

USPS state abbreviation such as AZ and FL

zipstring nullable

ZIP or postal code

dry_runboolean nullable

idinteger required

The unique IntakeForm identifier

shopping_urlstring uri nullable

Deeplink to the quoter with prefilled data according to the intake form. Null if the agent is not eligible for deeplinking. Agent must be associated with a deeplink-enabled agency to be eligible. Please reach out to HealthSherpa for deeplink access. When the create or update request included optional prescriptions and/or providers, those values are reflected only here (shop query parameters); they are not persisted on the intake form.

client_apply_urlstring uri nullable

Deeplink to the application page with prefilled data according to the intake form. Null if agent is not eligible for deeplinking. Agent must be associated with a deeplink-enabled agency to be eligible. Please reach out to HealthSherpa for deeplink access.