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

API calls for all endpoints tagged `EnvelopeDocumentFields`.

# `document_fields_delete_document_fields`

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

Deletes custom document fields from an existing envelope document.
Deletes custom document fields from an existing envelope document.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `document_id` (String.t): The unique ID of the document within the envelope.  Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).   Tab objects have a `documentId` property that specifies the document on which to place the tab. 
- `envelope_id` (String.t): The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
- `opts` (keyword): Optional parameters
  - `:body` (EnvelopeDocumentFields): 

### Returns

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

# `document_fields_get_document_fields`

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

Gets the custom document fields from an  existing envelope document.
Retrieves the custom document field information from an existing envelope document.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `document_id` (String.t): The unique ID of the document within the envelope.  Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).   Tab objects have a `documentId` property that specifies the document on which to place the tab. 
- `envelope_id` (String.t): The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
- `opts` (keyword): Optional parameters

### Returns

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

# `document_fields_post_document_fields`

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

Creates custom document fields in an existing envelope document.
Creates custom document fields in an existing envelope document.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `document_id` (String.t): The unique ID of the document within the envelope.  Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).   Tab objects have a `documentId` property that specifies the document on which to place the tab. 
- `envelope_id` (String.t): The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
- `opts` (keyword): Optional parameters
  - `:body` (EnvelopeDocumentFields): 

### Returns

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

# `document_fields_put_document_fields`

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

Updates existing custom document fields in an existing envelope document.
Updates existing custom document fields in an existing envelope document.

### Parameters

- `connection` (DocuSign.Connection): Connection to server
- `account_id` (String.t): The external account number (int) or account ID GUID.
- `document_id` (String.t): The unique ID of the document within the envelope.  Unlike other IDs in the eSignature API, you specify the `documentId` yourself. Typically the first document has the ID `1`, the second document `2`, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).   Tab objects have a `documentId` property that specifies the document on which to place the tab. 
- `envelope_id` (String.t): The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
- `opts` (keyword): Optional parameters
  - `:body` (EnvelopeDocumentFields): 

### Returns

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

---

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