Recipients

Create and manage form recipients with optional pre-filled answers.

Endpoints

GET/api/v1/forms/{id}/recipients

List recipients

Required scope:read:recipients

client.forms.byId("ID").recipients.get()

POST/api/v1/forms/{id}/recipients

Create recipient — Creates a recipient with an optional prefill map.

Required scope:write:recipients

client.forms.byId("ID").recipients.post(body)

PUT/api/v1/forms/{id}/recipients/{rid}

Update recipient

Required scope:write:recipients

client.forms.byId("ID").recipients.byRid("RID").put(body)

DELETE/api/v1/forms/{id}/recipients/{rid}

Delete recipient

Required scope:delete:recipients

client.forms.byId("ID").recipients.byRid("RID").delete()

GET/api/v1/forms/{id}/recipients/{rid}/responses

List recipient responses — Returns all saved responses for a recipient.

Required scope:read:recipients

client.forms.byId("ID").recipients.byRid("RID").responses.get()

PATCH/api/v1/forms/{id}/recipients/{rid}/responses

Update recipient responses — Update question values for a recipient. Rejected if recipient has completed the form.

Required scope:write:recipients

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.