Form tools - Claimr

A form is a set of pages, and each page holds blocks: questions or pieces of content. Participants fill in a form through a form task. Forms use the Rewards permission area.

Forms

Tool	What it does	Access
`claimr_get_forms`	Lists the forms of a campaign.	Rewards: read
`claimr_get_form`	Gets a form with all its pages and blocks, by name or ID.	Rewards: read
`claimr_create_form`	Creates an empty form.	Rewards: write
`claimr_update_form`	Changes a form’s name or settings.	Rewards: write
`claimr_delete_form`	Deletes a form. Refuses while a task still uses it.	Rewards: write

Pages

Tool	What it does	Access
`claimr_add_form_page`	Adds a page, at the end or at a given position. A form needs a page before it can hold questions.	Rewards: write
`claimr_update_form_page`	Changes a page.	Rewards: write
`claimr_delete_form_page`	Removes a page and every block on it.	Rewards: write

Blocks

Tool	What it does	Access
`claimr_add_form_block`	Adds a block to a page.	Rewards: write
`claimr_update_form_block`	Changes a block. Answer options kept with the same text keep their ID, so responses already collected still line up.	Rewards: write
`claimr_delete_form_block`	Removes a block.	Rewards: write

Block types:

text: a short answer.
long_text: a long answer.
select: a choice from a list of options.
quiz: a scored choice, with an explanation for each answer.
desc: formatted text between questions.
youtube_video: an embedded YouTube video.

Make the form reachable

Participants only reach a form through a task. After the form is built, ask the assistant to create a form task that points at it, for example:

Create a quiz form with five questions about our product, then add a form task for it to the Learn quest.

Responses

The assistant can’t read form responses, because they’re participants’ own answers. Open the form in the admin panel to see responses. See Security and privacy. Related pages: Forms, Quizzes, Form tasks.