View Source DocuSign.Api.Contacts (DocuSign v1.2.0)
API calls for all endpoints tagged Contacts.
Summary
Functions
Deletes a contact. This method deletes a contact associated with an account.
Deletes multiple contacts from an account. This method deletes multiple contacts associated with an account.
Gets one or more contacts.
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/
Add contacts to a contacts list. This method adds multiple contacts into a contacts list.
Updates one or more contacts. This method updates one or more contacts associated with an account.
Functions
contacts_delete_contact_with_id(connection, account_id, contact_id, opts \\ [])
View Source@spec contacts_delete_contact_with_id( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Deletes a contact. This method deletes a contact associated with an account.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.contact_id(String.t): The ID of a contact person in the account's address book.opts(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.ContactUpdateResponse.t}on success{:error, Tesla.Env.t}on failure
@spec contacts_delete_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Deletes multiple contacts from an account. This method deletes multiple contacts associated with an account.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(ContactModRequest):
Returns
{:ok, DocuSign.Model.ContactUpdateResponse.t}on success{:error, Tesla.Env.t}on failure
contacts_get_contact_by_id(connection, account_id, contact_id, opts \\ [])
View Source@spec contacts_get_contact_by_id( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ContactGetResponse.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets one or more contacts.
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/
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.contact_id(String.t): The ID of a contact person in the account's address book. Note: To return all contacts, omit this parameter. It is not required.opts(keyword): Optional parameters:cloud_provider(String.t): (Optional) The cloud provider from which to retrieve the contacts. Valid values are: -rooms-docusignCore(default)
Returns
{:ok, DocuSign.Model.ContactGetResponse.t}on success{:error, Tesla.Env.t}on failure
@spec contacts_post_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Add contacts to a contacts list. This method adds multiple contacts into a contacts list.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(ContactModRequest):
Returns
{:ok, DocuSign.Model.ContactUpdateResponse.t}on success{:error, Tesla.Env.t}on failure
@spec contacts_put_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Updates one or more contacts. This method updates one or more contacts associated with an account.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(ContactModRequest):
Returns
{:ok, DocuSign.Model.ContactUpdateResponse.t}on success{:error, Tesla.Env.t}on failure