Recipients

Recipients are the individuals or entities that receive an envelope to view or sign.

Management

Currently, recipients are not managed via a dedicated top-level API endpoint. Instead, they are managed as a sub-resource of the Envelope.

To add, update, or remove recipients, you must use the Update Envelope endpoint (PUT /api/envelopes/{id}).

Adding a Signer

To add a signer to an envelope, include them in the signers array in your update request.

Endpoint: PUT /api/envelopes/{id}

Body:

{
  "signers": [
    {
      "email": "[email protected]",
      "name": "Signer Name",
      "role": "signer",
      "recipientId": "1"
    }
  ]
}

Removing a Signer

To remove a signer, submit the signers array without that specific signer. The update operation replaces the entire signers list.

info

Future versions of the API may introduce dedicated endpoints (e.g., POST /envelopes/{id}/recipients) for more granular management.