API Reference
Recipients
Create and manage form recipients with optional pre-filled answers.
Recipients
Create and manage form recipients with optional pre-filled answers.
Endpoints
GET
/api/v1/forms/{id}/recipientsList recipients
Required permissions:recipients:read
client.forms.byId("ID").recipients.get()POST
/api/v1/forms/{id}/recipientsCreate recipient — Creates a recipient with an optional prefill map.
Required permissions:recipients:write
client.forms.byId("ID").recipients.post(body)POST
/api/v1/forms/{id}/recipients/bulkBulk create recipients — Creates up to 100 recipients in one request. Set sendNotifications=true to also require recipients:send_notifications. Conditional: recipients:send_notifications.
Required permissions:recipients:writerecipients:bulk
client.forms.byId("ID").recipients.bulk.post(body)PUT
/api/v1/forms/{id}/recipients/{rid}Update recipient
Required permissions:recipients:write
client.forms.byId("ID").recipients.byRid("RID").put(body)DELETE
/api/v1/forms/{id}/recipients/{rid}Delete recipient
Required permissions:recipients:write
client.forms.byId("ID").recipients.byRid("RID").delete()GET
/api/v1/forms/{id}/recipients/{rid}/responsesList recipient responses — Returns all saved responses for a recipient.
Required permissions:recipients:read
client.forms.byId("ID").recipients.byRid("RID").responses.get()PATCH
/api/v1/forms/{id}/recipients/{rid}/responsesUpdate recipient responses — Update question values for a recipient. Rejected if recipient has completed the form.
Required permissions:recipients:write
client.forms.byId("ID").recipients.byRid("RID").responses.get()This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.