For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Docusign eSignature includes a contacts list (also referred to as an address book) to help make sending envelopes even easier. When you send an envelope, the recipients’ names and email addresses are automatically added to your contacts list. You can use the contacts list to quickly add recipients to the envelopes you send. The Contacts resource provides methods that enable you to manage your contacts.
PUT/restapi/v2.1/accounts/{accountId}/contacts Updates one or more contacts.
Contacts properties
Property
Type
Description
canManage
string
cloudProvider
string
The cloud service that provided the contact. Valid values are:
rooms
docusignCore (default)
cloudProviderContainerId
string
The ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room.
contactId
string
The ID of a contact person in the account’s address book.
contactPhoneNumbers
array
A list of the contact’s phone numbers.
Note: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:
Sending an envelope by using SMS
Using phone authentication
You must ask the user who added the contact for the phone number and then manually enter it into the authentication box.
contactUri
string
The URI for retrieving information about the contact.
emails
array
The email address or addresses associated with the contact.
errorDetails
errorDetails
This object describes errors that occur. It is only valid for responses and ignored in requests.
isOwner
boolean
When true, the current user is the owner of the contact.
name
string
The name of the contact.
notaryContactDetails
notaryContactDetails
organization
string
The name of the contact’s organization.
roomContactType
string
shared
string
When true, the contact is shared. For more information, see Shared Contacts.
Note: The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:
Sending an envelope by using SMS
Using phone authentication
You must ask the user who added the contact for the phone number and then manually enter it into the authentication box.
signingGroup
string
If the contact belongs to a signing group, this property contains the signingGroupId.
signingGroupName
string
The name of the signing group that the contact belongs to.
