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

API calls for all endpoints tagged `TemplateRecipientTabs`.

# `recipients_delete_template_recipient_tabs`

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

Deletes the tabs associated with a recipient in a template.
Deletes one or more tabs associated with a recipient in a template.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `recipient_id` (String.t): A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`. 
- `template_id` (String.t): The ID of the template.
- `opts` (keyword): Optional parameters
  - `:body` (TemplateTabs): 

### Returns

- `{:ok, DocuSign.Model.Tabs.t}` on success
- `{:error, Req.Response.t}` on failure

# `recipients_get_template_recipient_tabs`

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

Gets the tabs information for a signer or sign-in-person recipient in a template.
Gets the tabs information for a signer or sign-in-person recipient in a template.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `recipient_id` (String.t): A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`. 
- `template_id` (String.t): The ID of the template.
- `opts` (keyword): Optional parameters
  - `:include_anchor_tab_locations` (String.t): When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**
  - `:include_metadata` (String.t): When **true,** the response includes metadata indicating which properties are editable.

### Returns

- `{:ok, DocuSign.Model.Tabs.t}` on success
- `{:error, Req.Response.t}` on failure

# `recipients_post_template_recipient_tabs`

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

Adds tabs for a recipient.
Adds one or more tabs for a recipient.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `recipient_id` (String.t): A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`. 
- `template_id` (String.t): The ID of the template.
- `opts` (keyword): Optional parameters
  - `:body` (TemplateTabs): 

### Returns

- `{:ok, DocuSign.Model.Tabs.t}` on success
- `{:error, Req.Response.t}` on failure

# `recipients_put_template_recipient_tabs`

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

Updates the tabs for a recipient.
Updates one or more tabs for a recipient in a template.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `recipient_id` (String.t): A local reference used to map recipients to other objects, such as specific document tabs.  A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope.  For example, many envelopes assign the first recipient a `recipientId` of `1`. 
- `template_id` (String.t): The ID of the template.
- `opts` (keyword): Optional parameters
  - `:body` (TemplateTabs): 

### Returns

- `{:ok, DocuSign.Model.Tabs.t}` on success
- `{:error, Req.Response.t}` on failure

---

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