Docusign Contacts API

The Contacts resource provides methods that allow you to manage contacts.

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /v2/accounts/{accountId}/contacts Replace contacts in the address book · Replaces contacts associated with an account for the DocuSign service #
Ask an LLM
“How do I update existing contacts in my address book?”
“Can I overwrite several contacts in one request?”
Tell an agent
Replace contacts {contacts} in account {account}.
Update the address book of account {account} with {contacts}.
POST /v2/accounts/{accountId}/contacts Import new contacts · Docusign Imports multiple new contacts into the contacts collection from CSV… #
Ask an LLM
“How do I add new contacts to my address book?”
“Can I import a batch of contacts from CSV, JSON or XML?”
Tell an agent
Import new contacts {contacts} into account {account}.
Add these people as new contacts in account {account}: {contacts}.
DELETE /v2/accounts/{accountId}/contacts Delete several contacts · Delete contacts associated with an account for the DocuSign service #
Ask an LLM
“How do I remove a batch of contacts from my address book?”
“Can I delete multiple contacts at once?”
Tell an agent destructive · confirm first
Delete contacts {contacts} from account {account}.
Bulk remove {contacts} from my address book.
GET /v2/accounts/{accountId}/contacts/{contactId} Get a single contact · Docusign Gets a particular contact associated with the user's account #
Ask an LLM
“What details are stored for a particular contact?”
“Can I look up one contact by its ID?”
Tell an agent
Get contact {contact} in account {account}.
Show me the address book entry {contact}.
DELETE /v2/accounts/{accountId}/contacts/{contactId} Delete a single contact · Replaces a particular contact associated with an account for the DocuSign… #
Ask an LLM
“How do I delete one contact by its ID?”
“Can I remove just a single person from my address book?”
Tell an agent destructive · confirm first
Delete contact {contact} from account {account}.
Remove address book entry {contact}.
PUT /v2.1/accounts/{accountId}/contacts Updates one or more contacts #
POST /v2.1/accounts/{accountId}/contacts Add contacts to a contacts list #
DELETE /v2.1/accounts/{accountId}/contacts Deletes multiple contacts from an account #
GET /v2.1/accounts/{accountId}/contacts/{contactId} Gets one or more contacts #
DELETE /v2.1/accounts/{accountId}/contacts/{contactId} Deletes a contact #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/docusign:docusign-contacts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

docusign-contacts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Docusign Contacts API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged Contacts across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: Contacts
  description: The Contacts resource provides methods that allow you to manage contacts.
paths:
  /v2/accounts/{accountId}/contacts:
    put:
      tags:
      - Contacts
      summary: Replaces contacts associated with an account for the DocuSign service
      operationId: Contacts_PutContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/contactUpdateResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: putContacts
      x-ds-method: update
      x-ds-service: Users
      x-ds-in-sdk: true
      x-codegen-request-body-name: contactModRequest
    post:
      tags:
      - Contacts
      summary: Docusign Imports multiple new contacts into the contacts collection from CSV…
      operationId: Contacts_PostContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest'
        required: false
      responses:
        '201':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/contactUpdateResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: postContacts
      x-ds-method: create
      x-ds-service: Users
      x-ds-in-sdk: true
      x-codegen-request-body-name: contactModRequest
    delete:
      tags:
      - Contacts
      summary: Delete contacts associated with an account for the DocuSign service
      operationId: Contacts_DeleteContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/contactUpdateResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteContacts
      x-ds-method: deleteList
      x-ds-service: Users
      x-ds-in-sdk: true
      x-codegen-request-body-name: contactModRequest
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/contacts/{contactId}:
    get:
      tags:
      - Contacts
      summary: Docusign Gets a particular contact associated with the user's account
      operationId: Contacts_GetContactById
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: contactId
        in: path
        description: The unique identifier of a person in the contacts address book.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/contactGetResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getContactById
      x-ds-method: get
      x-ds-service: Users
      x-ds-in-sdk: true
    delete:
      tags:
      - Contacts
      summary: Replaces a particular contact associated with an account for the DocuSign…
      operationId: Contacts_DeleteContactWithId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: contactId
        in: path
        description: The unique identifier of a person in the contacts address book.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/contactUpdateResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteContactWithId
      x-ds-method: delete
      x-ds-service: Users
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/contacts:
    parameters: []
    put:
      tags:
      - Contacts
      summary: Updates one or more contacts
      operationId: putV21AccountsByAccountIdContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactUpdateResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: putContacts
      description: This method updates one or more contacts associated with an account.
      x-ds-method: update
      x-ds-service: Users
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
      x-operation-id-source: normalized
      x-operation-id-original: Contacts_PutContacts
    post:
      tags:
      - Contacts
      summary: Add contacts to a contacts list
      operationId: postV21AccountsByAccountIdContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactUpdateResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: postContacts
      description: This method adds multiple contacts into a contacts list.
      x-ds-method: create
      x-ds-service: Users
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
      x-operation-id-source: normalized
      x-operation-id-original: Contacts_PostContacts
    delete:
      tags:
      - Contacts
      summary: Deletes multiple contacts from an account
      operationId: deleteV21AccountsByAccountIdContacts
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactUpdateResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteContacts
      description: This method deletes multiple contacts associated with an account.
      x-ds-method: deleteList
      x-ds-service: Users
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/contactModRequest_2'
      x-operation-id-source: normalized
      x-operation-id-original: Contacts_DeleteContacts
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/contacts/{contactId}:
    parameters: []
    get:
      tags:
      - Contacts
      summary: Gets one or more contacts
      operationId: getV21AccountsByAccountIdContactsByContactId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: contactId
        in: path
        description: 'The ID of a contact person in the account''s address book.


          **Note:** To return all contacts, omit this parameter. It is not required.'
        required: true
        schema:
          type: string
      - name: cloud_provider
        in: query
        required: false
        description: '(Optional) The cloud provider from which to retrieve the contacts. Valid values are:


          - `rooms`

          - `docusignCore` (default)'
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactGetResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getContactById
      description: 'This method returns one or more contacts

        associated with a Docusign account. You can also

        retrieve contacts from connected [cloud storage][CloudStorage] providers by using the

        `cloud_provider` query parameter. By default,

        contacts are retrieved from the Docusign account''s

        default address book.


        To return a specific contact, use the `contactId`

        query parameter. To return all contacts associated

        with an account, omit this parameter.


        [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/'
      x-ds-method: get
      x-ds-service: Users
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Contacts_GetContactById
    delete:
      tags:
      - Contacts
      summary: Deletes a contact
      operationId: deleteV21AccountsByAccountIdContactsByContactId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: contactId
        in: path
        description: The ID of a contact person in the account's address book.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contactUpdateResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteContactWithId
      description: This method deletes a contact associated with an account.
      x-ds-method: delete
      x-ds-service: Users
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Contacts_DeleteContactWithId
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    contact:
      type: object
      properties:
        contactId:
          type: string
          description: The unique identifier of a person in the contacts address book.
        contactPhoneNumbers:
          type: array
          description: '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.'
          items:
            $ref: '#/components/schemas/contactPhoneNumber'
        contactUri:
          type: string
          description: The URI for retrieving information about the contact.
        emails:
          type: array
          description: ''
          items:
            type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        name:
          type: string
          description: ''
        organization:
          type: string
          description: ''
        shared:
          type: string
          description: ''
        signingGroup:
          type: string
          description: ''
        signingGroupName:
          type: string
          description: "The display name for the signing group. \n\nMaximum Length: 100 characters. "
      description: ''
      x-ds-definition-name: contact
      x-ms-summary: ''
    contactGetResponse:
      type: object
      properties:
        contacts:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/contact'
        endPosition:
          type: string
          description: 'The last position in the result set. '
        nextUri:
          type: string
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
        previousUri:
          type: string
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
        resultSetSize:
          type: string
          description: 'The number of results returned in this response. '
        startPosition:
          type: string
          description: Starting position of the current result set.
        totalSetSize:
          type: string
          description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field.
      description: ''
      x-ds-definition-name: contactGetResponse
      x-ms-summary: ''
    contactPhoneNumber:
      type: object
      properties:
        phoneNumber:
          type: string
          description: ''
        phoneType:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: contactPhoneNumber
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    contactModRequest:
      type: object
      properties:
        contacts:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/contact'
      description: ''
      x-ds-definition-name: contactModRequest
      x-ms-summary: ''
    contactUpdateResponse:
      type: object
      properties:
        contacts:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/contact'
      description: ''
      x-ds-definition-name: contactUpdateResponse
      x-ms-summary: ''
    jurisdictionSummary:
      type: object
      properties:
        authorizedForIPen:
          description: ''
          type: string
        authorizedForRon:
          description: ''
          type: string
        jurisdictionId:
          description: '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`

            '
          type: string
        jurisdictionName:
          description: ''
          type: string
      x-ds-definition-name: jurisdictionSummary
      description: ''
      x-ms-summary: ''
    contact_2:
      type: object
      properties:
        canManage:
          description: ''
          type: string
        cloudProvider:
          description: 'The cloud service that provided the contact. Valid values are:


            - `rooms`

            - `docusignCore` (default)


            <!-- Future:


            - `Box`

            - `GoogleDrive`

            - `Dropbox`

            - `SalesForce`

            - `SkyDrive`


            -->'
          type: string
        cloudProviderContainerId:
          description: The ID of the container at the cloud provider. For example, this might be the room ID for a Docusign Transaction Room.
          type: string
        contactId:
          description: The ID of a contact person in the account's address book.
          type: string
        contactPhoneNumbers:
          description: '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.'
          type: array
          items:
            $ref: '#/components/schemas/contactPhoneNumber_2'
        contactUri:
          description: The URI for retrieving information about the contact.
          type: string
        emails:
          description: An array of email addresses.
          type: array
          items:
            type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        isOwner:
          description: ''
          type: boolean
        name:
          description: The name of the contact.
          type: string
        notaryContactDetails:
          $ref: '#/components/schemas/notaryContactDetails'
          description: ''
        organization:
          description: ''
          type: string
        roomContactType:
          description: ''
          type: string
        shared:
          description: When **true,** this contact is shared.
          type: string
        signingGroup:
          description: The ID of the signing group.
          type: string
        signingGroupName:
          description: "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
          type: string
      x-ds-definition-name: contact
      description: ''
      x-ms-summary: ''
    contactGetResponse_2:
      type: object
      properties:
        contacts:
          description: A list of contacts.
          type: array
          items:
            $ref: '#/components/schemas/contact_2'
        endPosition:
          description: 'The last index position in the result set. '
          type: string
        nextUri:
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
          type: string
        previousUri:
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
          type: string
        resultSetSize:
          description: The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
          type: string
        startPosition:
          description: The starting index position of the current result set.
          type: string
        totalSetSize:
          description: The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
          type: string
      description: This response object contains information about the contacts associated with an account.
      x-ds-definition-name: contactGetResponse
      x-ms-summary: This response object contains information about the contacts associated with an account.
    contactPhoneNumber_2:
      type: object
      properties:
        phoneNumber:
          description: 'The contact''s phone number.


            Example: `+12223334444`'
          type: string
        phoneType:
          description: 'The type of phone number. Valid values are:


            - `home`

            - `mobile`

            - `work`

            - `other`

            - `fax`'
          type: string
      description: Details about the phone numbers associated with a specific contact.
      x-ds-definition-name: contactPhoneNumber
      x-ms-summary: Details about the phone numbers associated with a specific contact.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    contactModRequest_2:
      type: object
      properties:
        contactList:
          description: A list of contacts.
          type: array
          items:
            $ref: '#/components/schemas/contact_2'
      description: The request object containing the new information for the contacts.
      x-ds-definition-name: contactModRequest
      x-ms-summary: The request object containing the new information for the contacts.
    contactUpdateResponse_2:
      type: object
      properties:
        contacts:
          description: A list of contacts.
          type: array
          items:
            $ref: '#/components/schemas/contact_2'
      description: This response objects shows the updated details for the contacts.
      x-ds-definition-name: contactUpdateResponse
      x-ms-summary: This response objects shows the updated details for the contacts.
    notaryContactDetails:
      type: object
      properties:
        hasDocusignCertificate:
          description: ''
          type: string
        jurisdictions:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/jurisdictionSummary'
      x-ds-definition-name: notaryContactDetails
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'