View Source DocuSign.Api.EnvelopeCustomFields (DocuSign v1.2.0)

API calls for all endpoints tagged EnvelopeCustomFields.

Summary

Functions

custom_fields_delete_custom_fields(connection, account_id, envelope_id, opts \\ [])

Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.

custom_fields_get_custom_fields(connection, account_id, envelope_id, opts \\ [])

Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. ### Related topics - How to get envelope custom tab values

custom_fields_post_custom_fields(connection, account_id, envelope_id, opts \\ [])

Creates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. ### Related topics - How to bulk send envelopes

custom_fields_put_custom_fields(connection, account_id, envelope_id, opts \\ [])

Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Functions

Link to this function

custom_fields_delete_custom_fields(connection, account_id, envelope_id, opts \\ [])

View Source 
@spec custom_fields_delete_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopeCustomFields.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeCustomFields):

Returns

  • {:ok, DocuSign.Model.EnvelopeCustomFields.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

custom_fields_get_custom_fields(connection, account_id, envelope_id, opts \\ [])

View Source 
@spec custom_fields_get_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CustomFieldsEnvelope.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. ### Related topics - How to get envelope custom tab values

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.CustomFieldsEnvelope.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

custom_fields_post_custom_fields(connection, account_id, envelope_id, opts \\ [])

View Source 
@spec custom_fields_post_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopeCustomFields.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Creates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. ### Related topics - How to bulk send envelopes

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeCustomFields):

Returns

  • {:ok, DocuSign.Model.EnvelopeCustomFields.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

custom_fields_put_custom_fields(connection, account_id, envelope_id, opts \\ [])

View Source 
@spec custom_fields_put_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopeCustomFields.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeCustomFields):

Returns

  • {:ok, DocuSign.Model.EnvelopeCustomFields.t} on success
  • {:error, Tesla.Env.t} on failure