Remove a recipient from a draft
Their assigned fields become unassigned.
View as MarkdownAuthorization
bearer In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/documents/string/recipients/string"{ "document": { "id": "string", "name": "string", "url": "string", "status": "string", "created": "2019-08-24T14:15:22Z", "modified": "2019-08-24T14:15:22Z", "size": 0, "pages": 0, "templateId": "string", "hasFile": true, "hasFinalFile": true, "files": [ { "id": "string", "name": "string", "position": 0, "size": 0, "pages": 0, "created": "2019-08-24T14:15:22Z", "status": "ready", "conversionError": "string" } ], "signingMode": "string", "message": "string", "sentAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "voidedAt": "2019-08-24T14:15:22Z", "voidReason": "string", "declinedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "autoRemindDays": 0, "lastRemindedAt": "2019-08-24T14:15:22Z", "legalHold": true, "scheduledPurgeAt": "2019-08-24T14:15:22Z", "visibility": "string", "ownerId": "string", "requiresNotarization": true, "notaryState": "string", "recipients": [ { "id": "string", "name": "string", "email": "string", "role": "string", "status": "string", "orderIndex": 0, "signedAt": "2019-08-24T14:15:22Z", "viewedAt": "2019-08-24T14:15:22Z", "declinedAt": "2019-08-24T14:15:22Z", "declineReason": "string", "hasAccessCode": true, "verificationMethod": "none", "signature": "string", "isGroup": true, "groupLabel": "string", "signedByName": "string", "signedByEmail": "string", "members": [ { "id": "string", "name": "string", "email": "string", "viewedAt": "2019-08-24T14:15:22Z", "declinedAt": "2019-08-24T14:15:22Z" } ], "reassignedFromName": "string", "reassignedFromEmail": "string", "reassignReason": "string", "reassignedAt": "2019-08-24T14:15:22Z" } ], "fields": [ { "id": "string", "type": "signature", "x": 0, "y": 0, "width": 0, "height": 0, "page": 0, "required": true, "label": "string", "value": "string", "recipientId": "string", "fileId": "string", "config": {} } ] }}Update a recipient on a draft, or correct one on a pending document
On a draft, the usual full edit (name, email, role, order, access code). On a pending document, only name and email may be corrected, and only for a recipient who hasn't signed yet — role, order, access code, and isGroup are structural, draft-only settings. Correcting email invalidates that recipient's current signing link (only theirs; every other recipient's token lives on their own row) and emails them a fresh one. Every correction is recorded in the document's audit trail with what changed. A correction can change a name but never blank it (a group slot always needs one too; only a draft individual may be nameless), and on a pending document cannot move a recipient onto an address another individual recipient already has, and once a payment has started on the slot the email cannot change at all (409 email_blocked_payment), because the charge belongs to the person who started it. Re-casing a recipient's own address is not a correction: it changes nothing and issues no new link. Names refuse control characters and invisible formatting characters (bidi overrides, zero-width space). Draft-only, isGroup true additionally converts an individual slot that has no email yet into a signer group (name becomes its label) — one-way, and only while the slot is still unaddressed; a group can't be converted back.
Add one or several candidate members to a signer-group slot (EAS-125)
Draft-only, and only on a recipient created with isGroup true and role "signer". Duplicate emails within the same group are rejected, case-insensitively, both here and at the database level. Send either name/email (one member) or members (several at once — e.g. adding a suggested roster in one action instead of one call per person) — never both. A batch is all-or-nothing: any invalid entry, or any entry colliding with an existing member or with another entry in the same batch, fails the whole call and nothing lands, so the caller never has to reconcile a partial result. Capped at 50 members per request either way.