Recipients
Create and manage form recipients with optional pre-filled answers.
Recipients
Create and manage form recipients with optional pre-filled answers.
Endpoints
Phone normalization
Phone inputs accept up to 80 characters.
- International input may include spaces, parentheses, and hyphens, but must include
+. - National input uses the workspace default phone country.
- Successful creates and edits return and store E.164, for example
+12025550100. - Invalid phone input returns
details.field,details.code, and an optional import row or signer index. - Existing rows are normalized only when used; they are not bulk rewritten.
Validation failures always return { success: false, error }; phone failures additionally include optional details with field, code, and an import/bulk row or signer index when applicable.
/api/v1/forms/{id}/recipientsList recipients
client.forms.byId("ID").recipients.get()/api/v1/forms/{id}/recipientsCreate recipient — Creates a recipient with an optional prefill map. Formatted phone input is normalized before storage; successful responses return canonical E.164.
client.forms.byId("ID").recipients.post(body)/api/v1/forms/{id}/recipients/bulkBulk create recipients — Creates up to 100 recipients in one request. A caller-owned bounded Idempotency-Key header is required; reuse it only with the exact same serialized request body. Set sendNotifications=true to also require recipients:send_notifications. Conditional: recipients:send_notifications.
createBulkRecipients(client, "ID", body, "YOUR_STABLE_IDEMPOTENCY_KEY")/api/v1/forms/{id}/recipients/{rid}Update recipient — Formatted phone input is normalized before storage; successful responses return canonical E.164.
client.forms.byId("ID").recipients.byRid("RID").put(body)/api/v1/forms/{id}/recipients/{rid}Delete recipient
client.forms.byId("ID").recipients.byRid("RID").delete()/api/v1/forms/{id}/recipients/{rid}/responsesList recipient responses — Returns all saved responses for a recipient.
client.forms.byId("ID").recipients.byRid("RID").responses.get()/api/v1/forms/{id}/recipients/{rid}/responsesUpdate recipient responses — Update question values for a recipient. Rejected if recipient has completed the form.
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.