LogoDOCS
OverviewAuthenticationRate LimitsErrors
Logo
Sign in →

The Recipient object

A Recipient object represents a person in your account's recipient directory. Recipients sign the documents in your envelopes; each envelope recipient references a Recipient through its recipientId, which stays the same for that person across envelopes.

Identity is the recipient id, not the email. The same email may map to several recipients in one account, each with its own name and metadata. This is useful for platforms where the same person interacts with several of your customers.

Recipients are being created in two ways. By creating an envelope with an email and name. Creating a recipient explicitly with theCreate Recipient endpoint always adds a new record, even when the email already exists.

Attributes
idstring

Unique identifier for the recipient. Use it to reference the recipient in envelopes and embedded signing links.

emailstring

Email address of the recipient. It cannot be changed after creation.

namestring

Display name shown for the recipient.

metadataobject

Custom key-value data you set on the recipient, for example your own user id.

createdAttimestamp

The date and time the recipient was created.

updatedAttimestamp

The date and time the recipient was last updated.

lastUsedAttimestamp

The date and time the recipient was last included in an envelope.

1{2  "id": "69d1a2b3c4d5e6f701234abc",3  "email": "[email protected]",4  "name": "Anna Smith",5  "metadata": {6    "internalUserId": "usr_123"7  },8  "createdAt": "2024-02-13T15:56:12.607Z",9  "updatedAt": "2024-02-14T09:12:03.000Z",10  "lastUsedAt": "2024-02-14T09:12:03.000Z"11}

Create Recipient

This endpoint creates a recipient. Creation never deduplicates. The same email may map to several recipients, each with its own name and metadata, because identity is the recipient id.

To reuse an existing recipient, reference it by recipientId when creating an envelope instead of creating a new one.

Body parameters
emailstringrequired

Email address of the recipient. It is immutable after creation.

namestringoptional

Display name shown for the recipient.

metadataobjectoptional

Custom key-value data you want to attach to the recipient, for example your own user id.

POST/recipient
CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
1curl \2  -H "Authorization: Bearer YOUR_API_KEY" \3  -H "Content-Type: application/json" \4  --request POST \5  --data '{"email": "[email protected]", "name": "Anna Smith", "metadata": {"internalUserId": "usr_123"}}' \6  https://api.pdfgate.com/recipient
JSON response - Recipient object
1{2  "id": "69d1a2b3c4d5e6f701234abc",3  "email": "[email protected]",4  "name": "Anna Smith",5  "metadata": {6    "internalUserId": "usr_123"7  },8  "createdAt": "2024-02-13T15:56:12.607Z",9  "updatedAt": "2024-02-13T15:56:12.607Z"10}

List Recipients

The List Recipients endpoint returns every recipient stored in your account with the given email. The match is exact and case-insensitive.

The same email may map to several recipients, so the result is a list. Use it to find the recipientId of a person you have previously included in an envelope.

Query parameters
emailstringrequired

Email to look up. Matched exactly, case-insensitively.

GET/recipients?email={email}
CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
1curl \2  -H "Authorization: Bearer YOUR_API_KEY" \3  --request GET \4  "https://api.pdfgate.com/[email protected]"
JSON response - list of Recipient objects
1{2  "recipients": [3    {4      "id": "69d1a2b3c4d5e6f701234abc",5      "email": "[email protected]",6      "name": "Anna Smith",7      "metadata": {8        "internalUserId": "usr_123"9      },10      "createdAt": "2024-02-13T15:56:12.607Z",11      "updatedAt": "2024-02-14T09:12:03.000Z",12      "lastUsedAt": "2024-02-14T09:12:03.000Z"13    }14  ]15}

Get Recipient

The Get Recipient endpoint returns a stored recipient.

Path parameters
idstringrequired

The recipient ID.

GET/recipient/{id}
CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
1curl \2  -H "Authorization: Bearer YOUR_API_KEY" \3  --request GET \4  https://api.pdfgate.com/recipient/{recipientId}
JSON response - Recipient object
1{2  "id": "69d1a2b3c4d5e6f701234abc",3  "email": "[email protected]",4  "name": "Anna Smith",5  "metadata": {6    "internalUserId": "usr_123"7  },8  "createdAt": "2024-02-13T15:56:12.607Z",9  "updatedAt": "2024-02-14T09:12:03.000Z",10  "lastUsedAt": "2024-02-14T09:12:03.000Z"11}

Update Recipient

The Update Recipient endpoint updates the display name or metadata of a recipient. Envelopes are not affected. They keep the recipient name they were created with, including envelopes that are still in progress.

The email cannot be changed after creation.

Path parameters
idstringrequired

The recipient ID.

Body parameters
namestringoptional

Display name shown for the recipient.

metadataobjectoptional

Custom key-value data you want to attach to the recipient. Replaces the stored metadata object.

PATCH/recipient/{id}
CURL
NODE.JS
PYTHON
GO
PHP
JAVA
C#
RUBY
1curl \2  -H "Authorization: Bearer YOUR_API_KEY" \3  -H "Content-Type: application/json" \4  --request PATCH \5  --data '{"name": "Anna Smith-Jones", "metadata": {"internalUserId": "usr_123"}}' \6  https://api.pdfgate.com/recipient/{recipientId}
JSON response - Recipient object
1{2  "id": "69d1a2b3c4d5e6f701234abc",3  "email": "[email protected]",4  "name": "Anna Smith-Jones",5  "metadata": {6    "internalUserId": "usr_123"7  },8  "createdAt": "2024-02-13T15:56:12.607Z",9  "updatedAt": "2024-02-20T10:30:00.000Z",10  "lastUsedAt": "2024-02-14T09:12:03.000Z"11}