DocuSign: Add contacts to a contacts list
DocuSign esignature.esignatureContactsPostContacts: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_contacts_postcontacts
Provider route: POST /restapi/v2.1/accounts/{accountId}/contacts. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureContactsPostContacts"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureContactsPostContacts(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_contacts_post_contacts(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
body | Model | Optional | Expand Updates one or more contacts — request body — body |
Referenced models: Updates one or more contacts — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Deletes a contact — response body |
Referenced models: Deletes a contact — response body
Schemas
Section titled “Schemas”Deletes a contact — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This response objects shows the updated details for the contacts. |
contacts | array | Optional | A list of contacts. |
contacts[] | Model | Each item | Expand Deletes a contact — response body — contacts item |
Referenced models: Deletes a contact — response body — contacts item
Updates one or more contacts — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request object containing the new information for the contacts. |
contactList | array | Optional | A list of contacts. |
contactList[] | Model | Each item | Expand Deletes a contact — response body — contacts item |
Referenced models: Deletes a contact — response body — contacts item
Deletes a contact — response body — contacts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
canManage | string | Optional | |
cloudProvider | string | Optional | The cloud service that provided the contact. Valid values are: - `rooms` - `docusignCore` (default) <!-- Future: - `Box` - `GoogleDrive` - `Dropbox` - `SalesForce` - `SkyDrive` --> |
cloudProviderContainerId | string | Optional | The ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room. |
contactId | string | Optional | The ID of a contact person in the account's address book. |
contactPhoneNumbers | array | Optional | 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. |
contactPhoneNumbers[] | Model | Each item | Expand Deletes a contact — response body — contacts item contact Phone Numbers item |
contactUri | string | Optional | The URI for retrieving information about the contact. |
emails | array | Optional | An array of email addresses. |
emails[] | string | Each item | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
isOwner | boolean | Optional | |
name | string | Optional | The name of the contact. |
notaryContactDetails | Model | Optional | Expand Deletes a contact — response body — contacts item notary Contact Details |
organization | string | Optional | |
roomContactType | string | Optional | |
shared | string | Optional | When **true,** this contact is shared. |
signingGroup | string | Optional | The ID of the signing group. |
signingGroupName | string | Optional | Optional. The name of the signing group. Maximum Length: 100 characters. |
Referenced models: Deletes a contact — response body — contacts item contact Phone Numbers item, Locks a template — response body — error Details, Deletes a contact — response body — contacts item notary Contact Details
Deletes a contact — response body — contacts item contact Phone Numbers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the phone numbers associated with a specific contact. |
phoneNumber | string | Optional | The contact's phone number. Example: `+12223334444` |
phoneType | string | Optional | The type of phone number. Valid values are: - `home` - `mobile` - `work` - `other` - `fax` |
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Deletes a contact — response body — contacts item notary Contact Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hasDocusignCertificate | string | Optional | |
jurisdictions | array | Optional | |
jurisdictions[] | Model | Each item | Expand Deletes a contact — response body — contacts item notary Contact Details jurisdictions item |
Referenced models: Deletes a contact — response body — contacts item notary Contact Details jurisdictions item
Deletes a contact — response body — contacts item notary Contact Details jurisdictions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorizedForIPen | string | Optional | |
authorizedForRon | string | Optional | |
jurisdictionId | string | Optional | The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds` |
jurisdictionName | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_contacts_postcontacts. Catalog operation: esignature:Contacts_PostContacts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.