# `DocuSign.Api.Contacts`
[🔗](https://github.com/neilberkman/docusign_elixir/blob/v3.5.1/lib/docusign/api/contacts.ex#L5)

API calls for all endpoints tagged `Contacts`.

# `contacts_delete_contact_with_id`

```elixir
@spec contacts_delete_contact_with_id(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Req.Response.t()}
```

Deletes a contact.
This method deletes a contact associated with an account.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_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, Req.Response.t}` on failure

# `contacts_delete_contacts`

```elixir
@spec contacts_delete_contacts(DocuSign.Connection.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Req.Response.t()}
```

Deletes multiple contacts from an account.
This method deletes multiple contacts associated with an account.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_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, Req.Response.t}` on failure

# `contacts_get_contact_by_id`

```elixir
@spec contacts_get_contact_by_id(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ContactGetResponse.t()} | {:error, Req.Response.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 server
- `account_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, Req.Response.t}` on failure

# `contacts_post_contacts`

```elixir
@spec contacts_post_contacts(DocuSign.Connection.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Req.Response.t()}
```

Add contacts to a contacts list.
This method adds multiple contacts into a contacts list.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_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, Req.Response.t}` on failure

# `contacts_put_contacts`

```elixir
@spec contacts_put_contacts(DocuSign.Connection.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Req.Response.t()}
```

Updates one or more contacts.
This method updates one or more contacts associated with an account.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_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, Req.Response.t}` on failure

---

*Consult [api-reference.md](api-reference.md) for complete listing*