PandaDoc · Schema

DocumentRecipientCreateRequest

Details for a recipient to be added to a document.

Document AutomationE-SignatureDocument ManagementDocument GenerationWebhooks

Properties

Name	Type	Description
first_name	string	First name of the recipient.
last_name	string	Last name of the recipient.
email	string	Email address of the recipient.
role	string	Role name mapping this recipient to fields in the document. Must match a role defined in the template.
signing_order	integer	Signing order position for sequential signing workflows. Omit to allow simultaneous signing.
phone	string	Phone number of the recipient.
contact_id	string	Optional contact identifier to link the recipient to a contact record.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DocumentRecipientCreateRequest",
  "title": "DocumentRecipientCreateRequest",
  "type": "object",
  "description": "Details for a recipient to be added to a document.",
  "required": [
    "first_name",
    "last_name"
  ],
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name of the recipient."
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the recipient."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the recipient."
    },
    "role": {
      "type": "string",
      "description": "Role name mapping this recipient to fields in the document. Must match a role defined in the template."
    },
    "signing_order": {
      "type": "integer",
      "description": "Signing order position for sequential signing workflows. Omit to allow simultaneous signing."
    },
    "phone": {
      "type": "string",
      "description": "Phone number of the recipient."
    },
    "contact_id": {
      "type": "string",
      "description": "Optional contact identifier to link the recipient to a contact record."
    }
  }
}