DocuSign.Api.UserSignatures.user_signatures_put_user_signature_by_id

You're seeing just the function user_signatures_put_user_signature_by_id, go back to DocuSign.Api.UserSignatures module for more information.
Link to this function

user_signatures_put_user_signature_by_id(connection, account_id, signature_id, user_id, opts \\ [])

View Source

Specs

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

Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • signature_id (String.t): The ID of the signature being accessed.
  • user_id (String.t): The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
  • opts (KeywordList): [optional] Optional parameters
    • :close_existing_signature (String.t): When set to true, closes the current signature.
    • :user_signature_definition (UserSignatureDefinition):

Returns

} on success {:error, info} on failure