Skip to main content
POST
Send an intake form

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Idempotency-Key
string

Unique key to ensure idempotent request handling.

Body

application/json
book_id
string
required

The book ID

intake_form_id
string
required

The published intake form ID

household_id
string
required

The client or prospect household ID

recipients
object

Recipient delivery types by household role

creator_copy_method
enum<string>
default:bcc
Available options:
bcc,
cc,
none
reminder_limit
integer
default:3
Required range: 0 <= x <= 10
reminder_interval_days
integer
default:3
Required range: 1 <= x <= 30

Response

intake form sent

id
string
required

The intake form invitation ID

Example:

"invitation123xyz"

book_id
string
required

The book ID

Example:

"book123xyz"

intake_form_id
string
required

The intake form ID

Example:

"form123xyz"

household_id
string
required

The recipient household ID

Example:

"household123xyz"

state
enum<string>
required
Available options:
open,
submitted,
expired,
revoked
delivery_method
enum<string>
required
Available options:
slant_email
creator_copy_method
enum<string>
required
Available options:
bcc,
cc,
none
sent_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required