DocuSign.Api.AccountCustomFields (DocuSign v0.3.3) View Source

API calls for all endpoints tagged AccountCustomFields.

Link to this section Summary

Functions

Gets a list of custom fields associated with the account. Retrieves a list of envelope custom fields associated with the account. 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. The list custom field lets the sender select the value of the field from a list you provide.

Link to this section Functions

Link to this function

account_custom_fields_delete_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

View Source

Specs

account_custom_fields_delete_account_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Delete an existing account custom field.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • custom_field_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :apply_to_templates (String.t):

Returns

} on success {:error, info} on failure

Link to this function

account_custom_fields_get_account_custom_fields(connection, account_id, opts \\ [])

View Source

Specs

account_custom_fields_get_account_custom_fields(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.AccountCustomFields.t()} | {:error, Tesla.Env.t()}

Gets a list of custom fields associated with the account. Retrieves a list of envelope custom fields associated with the account. 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. The list custom field lets the sender select the value of the field from a list you provide.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

account_custom_fields_post_account_custom_fields(connection, account_id, opts \\ [])

View Source

Specs

account_custom_fields_post_account_custom_fields(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.AccountCustomFields.t()} | {:error, Tesla.Env.t()}

Creates an acount custom field.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :apply_to_templates (String.t):
    • :custom_field (CustomField):

Returns

} on success {:error, info} on failure

Link to this function

account_custom_fields_put_account_custom_fields(connection, account_id, custom_field_id, opts \\ [])

View Source

Specs

account_custom_fields_put_account_custom_fields(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.AccountCustomFields.t()} | {:error, Tesla.Env.t()}

Updates an existing account custom field.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • custom_field_id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :apply_to_templates (String.t):
    • :custom_field (CustomField):

Returns

} on success {:error, info} on failure