View Source DocuSign.Api.TemplateCustomFields (DocuSign v1.2.0)
API calls for all endpoints tagged TemplateCustomFields.
Summary
Functions
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
Functions
custom_fields_delete_template_custom_fields(connection, account_id, template_id, opts \\ [])
View Source@spec custom_fields_delete_template_custom_fields( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.CustomFields.t()} | {:error, Tesla.Env.t()}
Deletes envelope custom fields in a template. Deletes envelope custom fields in a template.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.template_id(String.t): The ID of the template.opts(keyword): Optional parameters:body(TemplateCustomFields):
Returns
{:ok, DocuSign.Model.CustomFields.t}on success{:error, Tesla.Env.t}on failure
custom_fields_get_template_custom_fields(connection, account_id, template_id, opts \\ [])
View Source@spec custom_fields_get_template_custom_fields( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.CustomFields.t()} | {:error, Tesla.Env.t()}
Gets the custom document fields from a template. Retrieves the custom document field information from an existing template.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.template_id(String.t): The ID of the template.opts(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.CustomFields.t}on success{:error, Tesla.Env.t}on failure
custom_fields_post_template_custom_fields(connection, account_id, template_id, opts \\ [])
View Source@spec custom_fields_post_template_custom_fields( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.CustomFields.t()} | {:error, Tesla.Env.t()}
Creates custom document fields in an existing template document. Creates custom document fields in an existing template document.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.template_id(String.t): The ID of the template.opts(keyword): Optional parameters:body(TemplateCustomFields):
Returns
{:ok, DocuSign.Model.CustomFields.t}on success{:error, Tesla.Env.t}on failure
custom_fields_put_template_custom_fields(connection, account_id, template_id, opts \\ [])
View Source@spec custom_fields_put_template_custom_fields( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.CustomFields.t()} | {:error, Tesla.Env.t()}
Updates envelope custom fields in a template. Updates the custom fields in a template. Each custom field used in a template must have a unique name.
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.template_id(String.t): The ID of the template.opts(keyword): Optional parameters:body(TemplateCustomFields):
Returns
{:ok, DocuSign.Model.CustomFields.t}on success{:error, Tesla.Env.t}on failure