Forms

Create form

Creates a new Form, optionally with fields nested via form_fields_attributes. Set delivery_type (with delivery_file_id, delivery_url or experience_id) to email a file, link or experience to everyone who submits, and tag_ids to tag them. With confirmation_required (double opt-in), tags and delivery wait until the person confirms. Submissions come in through POST /forms/{form_id}/submissions.

post/forms

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/forms
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

namestring
redirect_urlstring nullable

Full https:// URL people land on after they click the confirmation link, with confirmation_required on.

delivery_type'none' | 'file' | 'link' | 'experience'

What everyone who submits gets by email, on every submission. none turns delivery off; file needs delivery_file_id, link needs delivery_url, experience needs experience_id.

delivery_urlstring nullable

Full https:// URL to send: a page, video or download elsewhere.

experience_idstring nullable

Experience ID to grant access to; the email carries a sign-in link.

delivery_subjectstring nullable

Subject of the delivery email. Defaults to "Your freebie from <business> is here!".

delivery_messagestring nullable

Plain-text body of the delivery email; the download button is added below it.

archived_atstring date-time nullable
tag_idsstring[]

Tag IDs added to everyone who submits (never replacing their other tags). With confirmation_required, once they confirm.

settingsobject
confirmation_requiredboolean

Double opt-in: tags and the lead magnet wait until the person clicks the confirmation link.

delivery_file_idstring

File ID (file_..., from the Files API) to send as a download.

Response

Form created

idstring required
objectstring required
namestring required
redirect_urlstring nullable required
settingsobject required
archived_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
confirmation_requiredboolean required
tag_idsstring[] required
delivery_urlstring nullable required
delivery_subjectstring nullable required
delivery_messagestring nullable required
delivery_type'none' | 'file' | 'link' | 'experience' required
delivery_fileobject nullable required
experience_idstring nullable required
submissions_countnumber required

Changes

No recorded changes to this operation across all 2 revisions of this API.