Recipients & Pre-fill
Add recipients to a form with optional pre-filled answers.
Recipients
A recipient is a person invited to fill out a form. Each recipient gets a unique link and optionally pre-filled answers.
GET
/api/v1/forms/{id}/recipientsRequired scope:read:recipients
POST
/api/v1/forms/{id}/recipientsCreate a recipient with optional pre-fill
Required scope:write:recipients
PUT
/api/v1/forms/{id}/recipients/{rid}Update a recipient
Required scope:write:recipients
DELETE
/api/v1/forms/{id}/recipients/{rid}Delete a recipient
Required scope:delete:recipients
Create a recipient
Request Body
| Name | Type | Description |
|---|---|---|
| label | string | Display name for the recipientJohn Doe |
| Triggers invitation email if a mail integration is configured | ||
| phone | string | Phone number (for SMS notifications if configured) |
| password | string | Password-protect the form link (min 4 chars) |
| expires_at | datetime | ISO 8601 expiry — link becomes inactive after this time |
| prefill | object | Map of questionId → value. Saves responses immediately. |
Pre-filling answers
The prefill field accepts a map of question IDs to values. The API saves these as Response records immediately — the recipient will see the answers pre-populated when they open the link.
curl -X POST https://formalingo.com/api/v1/forms/FORM_ID/recipients \
-H "Authorization: Bearer af_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "John Doe",
"email": "john@acme.com",
"expires_at": "2026-03-31T23:59:59Z",
"prefill": {
"question-uuid-1": "John Doe",
"question-uuid-2": "Acme Corp",
"question-uuid-3": "john@acme.com"
}
}'Response201
{
"success": true,
"data": {
"id": "recipient-uuid",
"form_id": "form-uuid",
"label": "John Doe",
"email": "john@acme.com",
"token": "abc123",
"status": "not_started",
"is_active": true,
"is_anonymous": false,
"has_password": false,
"link": "https://formalingo.com/f/abc123",
"response_count": 3,
"visit_count": 0,
"total_questions": 5,
"created_at": "2026-02-25T10:00:00.000Z"
}
}The recipient link
The link field in the response is the URL the recipient uses to fill out the form. Share this via email, embed it in your application, or use it for redirects.