Intake Forms

Send an intake form

Changed on

Create an invitation and queue delivery through Slant email to an existing client or prospect household. A successful response confirms queued delivery, not inbox receipt. Returns invitation metadata only, never answers, prefilled values, or access tokens.

post/v1/intake_form_invitations

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/intake_form_invitations
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling.

Request body

book_idstring required

The book ID

intake_form_idstring required

The published intake form ID

household_idstring required

The client or prospect household ID

creator_copy_method'bcc' | 'cc' | 'none'
reminder_limitinteger
reminder_interval_daysinteger
prefill_answersobject

Optional values keyed by editable field keys from the latest published field definitions. Overrides automatic prefill for supplied fields; omitted fields keep automatic prefill. Null clears a field. Unknown keys, invalid values, files, calculations, acknowledgments, and booking controls return 422. Values are not returned.

Response

intake form invitation queued

idstring required

The intake form invitation ID

book_idstring required

The book ID

intake_form_idstring required

The intake form ID

household_idstring required

The recipient household ID

state'open' | 'submitted' | 'expired' | 'revoked' required
delivery_method'slant_email' required
creator_copy_method'bcc' | 'cc' | 'none' required
sent_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "invitation123xyz",
  "book_id": "book123xyz",
  "intake_form_id": "form123xyz",
  "household_id": "household123xyz"
}

Changes