• Preparing search index...
  • The search index is not available
@verdocs/js-sdk - v3.10.30
  • @verdocs/js-sdk
  • Templates
  • Fields
  • updateField

Function updateField

  • updateField(endpoint, templateId, fieldName, params): Promise<ITemplateField>
  • Update a template field.

    Parameters

    • endpoint: VerdocsEndpoint
    • templateId: string
    • fieldName: string
    • params: Partial<ITemplateField>

    Returns Promise<ITemplateField>

    • Defined in Templates/Fields.ts:15

Settings

Member Visibility

Theme

@verdocs/js-sdk - v3.10.30
  • Envelopes
    • Envelopes
      • ICreateEnvelopeRequest
      • IEnvelopeSearchParams
      • IListEnvelopesParams
      • ISigningSessionResult
      • ITimeRange
      • cancelEnvelope
      • createEnvelope
      • deleteEnvelopeFieldAttachment
      • getDocumentDownloadLink
      • getDocumentPreviewLink
      • getEnvelope
      • getEnvelopeDocument
      • getEnvelopeDocumentPageDisplayUri
      • getEnvelopeFile
      • getEnvelopeRecipients
      • getEnvelopesByTemplateId
      • getFieldAttachment
      • getSigningSession
      • getSummary
      • listEnvelopes
      • searchEnvelopes
      • throttledGetEnvelope
      • updateEnvelopeField
      • updateEnvelopeFieldInitials
      • updateEnvelopeFieldSignature
      • uploadEnvelopeFieldAttachment
    • Initials
      • IInitials
      • createInitials
    • Permissions
      • envelopeIsActive
      • envelopeIsComplete
      • getNextRecipient
      • getRecipientsWithActions
      • recipientCanAct
      • recipientHasAction
      • userCanAct
      • userCanCancelEnvelope
      • userCanFinishEnvelope
      • userCanSignNow
      • userIsEnvelopeOwner
      • userIsEnvelopeRecipient
    • Recipients
      • IInPersonLinkResponse
      • ISignerTokenResponse
      • IUpdateRecipientAgreedParams
      • IUpdateRecipientClaimEnvelope
      • IUpdateRecipientDeclineParams
      • IUpdateRecipientNameParams
      • IUpdateRecipientPrepareParams
      • IUpdateRecipientStatus
      • IUpdateRecipientSubmitParams
      • envelopeRecipientAgree
      • envelopeRecipientChangeOwner
      • envelopeRecipientDecline
      • envelopeRecipientPrepare
      • envelopeRecipientSubmit
      • envelopeRecipientUpdateName
      • getInPersonLink
      • getSignerToken
      • resendInvitation
      • sendDelegate
      • updateRecipient
    • Reminders
      • ICreateEnvelopeReminderRequest
      • createReminder
      • deleteReminder
      • getReminder
      • updateReminder
    • Signatures
      • ISignature
      • createSignature
      • deleteSignature
      • getSignature
      • getSignatures
    • Types
      • DocumentFieldTypes
      • EnvelopeStates
      • RecipientActions
      • RecipientStates
      • RecipientTypes
      • IActivityEntry
      • ICreateEnvelopeRole
      • IDocumentSearchOptions
      • IEmailAccessKey
      • IEnvelope
      • IEnvelopeDocument
      • IEnvelopeField
      • IEnvelopeFieldOptions
      • IEnvelopeFieldSettings
      • IEnvelopeSummaries
      • IEnvelopeSummary
      • IEnvelopesSearchResult
      • IEnvelopesSearchResultEntry
      • IEnvelopesSummary
      • IHistory
      • IInPersonAccessKey
      • IRecipient
      • ISMSAccessKey
      • ISigningSessionRequest
      • TAccessKey
      • TDocumentFieldType
      • TEnvelopeStatus
      • TEnvelopeUpdateResult
      • TEventDetail
      • THistoryEvent
      • TRecipientAction
      • TRecipientStatus
      • TRecipientType
  • Organizations
    • ApiKeys
      • createKey
      • deleteKey
      • getKeys
      • rotateKey
      • updateKey
    • Groups
      • addMembers
      • addPermission
      • deleteMembers
      • deletePermission
      • getGroup
      • getGroupByName
      • getGroups
      • getMembers
    • Invitations
      • ICreateInvitationRequest
      • acceptInvitation
      • claimNewUser
      • createInvitation
      • declineInvitation
      • deleteInvitation
      • getInvitation
      • getInvitations
      • resendInvitation
      • updateInvitation
    • Members
      • addMemberRole
      • deleteMember
      • deleteMemberRole
      • getMemberPlans
      • getMembers
    • Organizations
      • createOrganization
      • deleteOrganization
      • getOrganization
      • getOrganizations
      • updateOrganization
    • Types
      • IApiKey
      • IApiKeyWithSecret
      • ICreateApiKeyRequest
      • IGroup
      • IGroupDetail
      • IInvitation
      • IOrganization
      • IPermissionDetail
      • IRoleDetail
      • IUpdateApiKeyRequest
    • Webhooks
      • ISetWebhookRequest
      • IWebhook
      • getWebhooks
      • setWebhooks
    • Whitelabel
      • getWhitelabel
      • setWhitelabel
  • Sessions
    • Types
      • ISigningSession
      • ISigningSessionRequest
      • IUserSession
      • TActiveSession
      • TSession
      • TSessionType
    • userHasPermissions
  • Templates
    • Actions
      • TemplatePermissions
      • TemplateSenderTypes
      • TTemplateActions
      • canPerformTemplateAction
      • hasRequiredPermissions
    • Fields
      • createField
      • deleteField
      • updateField
    • Pages
      • ICreatePageParams
      • IPageImageResponse
      • createPage
      • deletePage
      • editPage
      • getPage
      • getPageImage
    • Reminders
      • ICreateTemplateReminderRequest
      • createReminder
      • deleteReminder
      • getReminder
      • updateReminder
    • Roles
      • createRole
      • deleteRole
      • deleteSequence
      • getRole
      • getRoleFields
      • getRoles
      • updateRole
    • Stars
      • getStars
      • toggleStar
    • Tags
      • addTemplateTag
      • createTag
      • deleteTemplateTag
      • getAllTags
      • getTag
      • getTemplateTags
    • TemplateDocuments
      • createTemplateDocument
      • deleteTemplateDocument
      • getTemplateDocument
      • getTemplateDocumentFile
      • getTemplateDocumentPageDisplayUri
      • getTemplateDocumentThumbnail
      • getTemplateDocuments
    • Templates
      • SortOptions
      • IDocumentFromData
      • IDocumentFromUri
      • IGetTemplateSummaryParams
      • IGetTemplatesParams
      • ISearchTimeRange
      • ITemplateCreateFromSharepointParams
      • ITemplateCreateParams
      • ITemplateListParams
      • ITemplateSearchParams
      • ITemplateSearchResult
      • ITimePeriod
      • IGetTemplateSummarySortBy
      • createTemplate
      • createTemplateFromSharepoint
      • createTemplatev2
      • deleteTemplate
      • getSummary
      • getTemplate
      • getTemplateOwnerInfo
      • getTemplates
      • listTemplates
      • searchTemplates
      • throttledGetTemplate
      • updateTemplate
    • Types
      • SortOptions
      • TemplateActions
      • TemplateSenderTypes
      • IPage
      • IReminder
      • IRole
      • IStar
      • ITag
      • ITemplate
      • ITemplateDocument
      • ITemplateField
      • ITemplateFieldSetting
      • ITemplateOwnerInfo
      • ITemplateSearchParams
      • ITemplateSummaries
      • ITemplateSummary
      • ITemplateTag
      • ITextFieldSetting
      • ITimePeriod
      • TTemplateAction
      • TTemplateSender
    • Validators
      • IValidator
      • getValidator
      • getValidators
      • isValidEmail
      • isValidPhone
      • isValidRoleName
      • isValidTag
  • Users
    • Auth
      • ICreateUserRequest
      • authenticateApp
      • authenticateUser
      • createUser
      • refreshTokens
      • resendVerification
      • resetPassword
      • updateEmail
      • updatePassword
      • validateToken
    • Billing
      • billingPlaceholder
    • Notifications
      • getNotifications
    • Profiles
      • ICreateBusinessAccountRequest
      • ISignupSurvey
      • createBusinessAccount
      • createProfile
      • deleteProfile
      • getCurrentProfile
      • getPermissions
      • getProfile
      • getProfileGroups
      • getProfilePermissions
      • getProfiles
      • getRoles
      • recordSignupSurvey
      • switchProfile
      • updateProfile
    • Types
      • Permissions
      • Plans
      • Roles
      • IAuthenticateAppRequest
      • IAuthenticateResponse
      • IAuthenticateUserRequest
      • ICreateProfileRequest
      • IPermission
      • IProfile
      • IRole
      • ISwitchProfileResponse
      • IUpdatePasswordRequest
      • IUpdateProfileRequest
      • TokenValidationRequest
      • TokenValidationResponse
      • UpdateEmailRequest
      • UpdateEmailResponse
      • UpdatePasswordResponse
      • TPermission
      • TPlan
      • TRequestStatus
      • TRole
  • Utils
    • Colors
      • getRGB
      • getRGBA
      • getRoleColor
      • nameToRGBA
    • DateTime
      • ITimePeriod
      • formatShortTimeAgo
      • timePeriod
    • Fields
      • blobToBase64
      • getRLeft
      • getRTop
      • getRValue
      • rescale
    • Files
      • FileWithData
      • downloadBlob
      • fileToDataUrl
    • Locales
      • ICountry
      • Countries
      • getCountryByCode
      • getMatchingCountry
      • getPlusOneCountry
      • isAmericanSamoa
      • isCanada
      • isDominicanRepublic
      • isFrenchGuiana
      • isGuadeloupe
      • isMartinique
      • isMayotte
      • isPuertoRico
    • Primitives
      • formatFullName
      • formatInitials
      • fullNameToInitials
      • integerSequence
    • Strings
      • capitalize
      • convertToE164
    • Token
      • AtoB
      • decodeAccessTokenBody
      • decodeJWTBody
  • VerdocsEndpoint
  • VerdocsEndpointOptions
  • TEnvironment
  • TSessionChangedListener