---
title: "Update an eSignature package"
method: PUT
path: "/e-signature-packages/{id}"
tags: ["ESignature Packages"]
---

# Update an eSignature package

`PUT /e-signature-packages/{id}`

Update an eSignature package, which must be in `DRAFT` status.

## Request body

- object
  - `title` string — The title of the eSignature package.
  - `description` string — Description of of the eSignature package.
  - `owner` string — Pactima ID of the owner of the package. Defaults to the id of the requester; when using as Team Integration API Key, the request can specify any team member
  - `kind` 'IN_PERSON' | 'LIVE' | 'STANDARD'
  - `orderedSigners` boolean — Determine if signers are ordered, only for STANDARD eSignature kinds
  - `schedulingDetails` ESignatureSchedulingDetails
    - `timezone` string — Timezone used to format the date in the notifications. Timezone must be a valid [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
    - `date` string — The start time in ISO 8601 format. The format of is always 24 or 27 characters long `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
    - `durationInMinutes` integer — Duration
  - `signers` ESignatureSigner[] — Bulk signers updates. Only when the package is in DRAFT.
    - `id` string
    - `name` string, required
    - `email` string, required
    - `phoneNumber` string
    - `participantPoolItem` ESignatureSignerParticipantPoolItem — An item in a participant pool representing a specific request or assignment
      - `id` string — Unique identifier for the participant pool item
      - `participantPoolId` string, required — ID of the participant pool this item belongs to
      - `status` 'DRAFT' | 'AWAITING_TAGGING' | 'AWAITING_PARTICIPANT_PREFERENCE' | 'REQUEST_SENT_TO_ENROLLEES' | 'MATCHED' | 'STALE' | 'CANCELLED' | 'COMPLETED', required — Current status of a participant pool item
      - `linkedObject` ParticipantPoolItemLinkedObject — Object linked to a participant pool item
        - `objectId` string, required — Identifier of the linked object
        - `kind` 'E_SIGNATURE_PACKAGE', required — Type of object linked to the participant pool item
        - `linkedParticipantId` string — ID of the linked participant in the object (e.g. signer id)
      - `scheduling` ParticipantPoolItemScheduling — Scheduling configuration for a participant pool item
        - `dateType` 'FIXED' | 'DATE_RANGE', required — Type time preference for the participant pool item
        - `schedulingMode` 'PRE_SCHEDULED' | 'ON_DEMAND', required — Matching mechanism for scheduling participants
        - `startDate` string, date-time — Earliest date of availability
        - `endDate` string, date-time — Latest possible date for the item
        - `timezone` string — Timezone for scheduling (e.g. 'America/New_York')
        - `duration` integer — Duration of the meeting in minutes
        - `scheduleSetterParticipantId` string — ID of the participant who sets the schedule
        - `queueForTagging` boolean — Whether the item should be queued for tagging
        - `bid` ParticipantPoolItemSchedulingBid — Bidding configuration for participant pool item scheduling
          - `maxPrice` number — Maximum price willing to pay for the scheduling slot
          - `currency` string — Currency code for the price (e.g., USD, EUR)
        - `counterBids` ParticipantPoolItemSchedulingCounterBid[] — Counter bids for this scheduling item
          - `id` string — Unique identifier for the counter bid
          - `counter` ParticipantPoolItemSchedulingBid, required — Bidding configuration for participant pool item scheduling
            - `maxPrice` number — Maximum price willing to pay for the scheduling slot
            - `currency` string — Currency code for the price (e.g., USD, EUR)
          - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED', required — Status of a counter bid for participant pool item scheduling
          - `publicId` string — Public identifier of the counter bidder
          - `name` string — Name of the counter bidder
          - `email` string — Email of the counter bidder
          - `createdAt` string, date-time — Timestamp when the counter bid was created
          - `updatedAt` string, date-time — Timestamp when the counter bid was last updated
          - `respondedAt` string, date-time — Timestamp when the counter bid was accepted or rejected
      - `ownershipRegistry` ParticipantPoolItemOwnershipRegistryItem[] — Registry of owners for this item
        - `role` 'OWNER' | 'ADMIN' | 'ENROLLEE' | 'ASSIGNER' | 'TAGGER', required — Role of a member within the participant pool
        - `publicId` string, required — Public identifier of the owner
        - `timestamp` string, date-time — When this ownership change occurred
        - `reason` string — Optional reason for the ownership change
      - `assignmentRules` ParticipantPoolItemAssignmentRule[]
        - `ruleId` string
        - `metadata` unknown
      - `participantPoolName` string
    - `attachmentRequests` ESignatureSignerAttachmentRequest[]
      - `id` string
      - `name` string, required
      - `description` string
      - `isOptional` boolean — Set to true if the request is optional
      - `isConfidential` boolean — Set to true if the attachment should not be shared with other signers; only the owner
    - `specialRoles` ESignatureSignerSpecialRoleEnum[]
    - `viewRestrictions` ESignatureSignerViewRestrictionEnum[]
  - `ccRecipients` ESignatureCCRecipient[] — Bulk ccRecipients updates. Only when the package is in DRAFT.
    - `id` string
    - `name` string, required
    - `email` string, required
    - `specialRoles` ESignatureCCRecipientSpecialRoleEnum[]
  - `advancedOptions` ESignatureAdvancedOptions
    - `disableRepeatEntries` boolean
    - `penColor` 'SIGNER_SELECTED_COLOR' | 'BLACK' | 'BLUE' | 'RED' | 'GREEN'
    - `signatureTypes` SignatureTypeEnum[]
    - `notifications` ESignatureAdvancedOptionsNotificationItem[] — Settings for notification regarding this eSignature package
      - `event` union
        - 'ACTIVATED' | 'CANCELLED' | 'REDRAFTED' | 'COMPLETED' | 'DECLINED' | 'DELIVERY_FAILED' | 'DISABLE_RECORDING' | 'ENABLE_REPEAT_ENTRIES' | 'DISABLE_REPEAT_ENTRIES' | 'ENABLE_RECORDING' | 'LIVE_EDITING_STARTED' | 'LIVE_EDITING_FINISHED' | 'JOINT_SIGNERS_GROUP_CREATED' | 'JOINT_SIGNERS_GROUP_REMOVED' | 'LIVE_STARTED' | 'LIVE_ENDED' | 'LOCKED_FOR_REVIEW' | 'UNLOCKED_FROM_REVIEW' | 'OBSERVER_INVITED' | 'OBSERVER_REMOVED' | 'PREPARED' | 'REMINDER' | 'REMINDER_BY_TEXT_MESSAGE' | 'RESCHEDULED' | 'SENT' | 'SCHEDULED' | 'SIGNED' | 'SIGNER_ADDED' | 'SIGNER_REMOVED' | 'TRANSFERRED' | 'VIEWED'
        - 'EVENTS.ALL'
      - `participantId` union — This is the signerId, ownerId, or agreemaId of (essentially their participant id), Special participant IDs include, SIGNERS.ALL, which applies to all singers.
        - 'SIGNERS.ALL' | 'OBSERVERS.ALL' | 'PREPARERS.ALL' | 'PARTICIPANTS.ALL'
        - string
      - `enabled` boolean
    - `exitRedirectUriConfigurations` ESignatureAdvancedOptionsExitRedirectUriConfigItem[] — Settings for exit redirect uri for this eSignature package
      - `redirectUri` string — URI when the participant is exiting the signing ceremony
      - `participantId` union
        - 'OWNER' | 'SIGNER' | 'CC_RECIPIENT' | 'ARCHIVED_CC_RECIPIENT' | 'ARCHIVED_SIGNER' | 'ARCHIVED_OWNER'
        - string — This is the signerId or ownerId, or agreemaId
    - `resetENotaryAuthAtEntry` boolean — Reset the eNotary authentication at each entry
    - `cancelAtENotaryAuthFailure` boolean — Cancel the eSignature package if one of the eNotary validation fails
    - `inlineWebhook` InlineWebhook — unresolved $ref
    - `liveCeremonyLocks` ESignatureAdvancedOptionsLiveCeremonyLockEnum[]
  - `eNotaryPackageId` string — Submit empty string, i.e. '', to remove eNotary link to this eSignature package
  - `customBrandItemId` string — ID of the custom brand item to use for the package. Owner must have own the specified the custom brand item.

## Response `200`

Returns the object if successfully updated. Returns an error if the update parameters are invalid.

- ESignaturePackage
  - `id` string, required
  - `isTestMode` boolean
  - `title` string, required
  - `description` string
  - `documents` ESignatureDocument[]
    - `id` string
    - `name` string
    - `pageCount` number
    - `entryPads` ESignatureEntryPad[]
      - `id` string
      - `signerId` string, required — Id of the signer
      - `type` 'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email', required
      - `left` number, required — Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `top` number, required — Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `height` number, required — Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `width` number, required — Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.
      - `pageIndex` number, required — Page index whereby the entry pad is contained in the document.
      - `isOptional` boolean — Set to true if the entry pad is optional.
      - `metadata` unknown
  - `signers` ESignatureSigner[]
    - `id` string
    - `name` string, required
    - `email` string, required
    - `phoneNumber` string
    - `participantPoolItem` ESignatureSignerParticipantPoolItem — An item in a participant pool representing a specific request or assignment
      - `id` string — Unique identifier for the participant pool item
      - `participantPoolId` string, required — ID of the participant pool this item belongs to
      - `status` 'DRAFT' | 'AWAITING_TAGGING' | 'AWAITING_PARTICIPANT_PREFERENCE' | 'REQUEST_SENT_TO_ENROLLEES' | 'MATCHED' | 'STALE' | 'CANCELLED' | 'COMPLETED', required — Current status of a participant pool item
      - `linkedObject` ParticipantPoolItemLinkedObject — Object linked to a participant pool item
        - `objectId` string, required — Identifier of the linked object
        - `kind` 'E_SIGNATURE_PACKAGE', required — Type of object linked to the participant pool item
        - `linkedParticipantId` string — ID of the linked participant in the object (e.g. signer id)
      - `scheduling` ParticipantPoolItemScheduling — Scheduling configuration for a participant pool item
        - `dateType` 'FIXED' | 'DATE_RANGE', required — Type time preference for the participant pool item
        - `schedulingMode` 'PRE_SCHEDULED' | 'ON_DEMAND', required — Matching mechanism for scheduling participants
        - `startDate` string, date-time — Earliest date of availability
        - `endDate` string, date-time — Latest possible date for the item
        - `timezone` string — Timezone for scheduling (e.g. 'America/New_York')
        - `duration` integer — Duration of the meeting in minutes
        - `scheduleSetterParticipantId` string — ID of the participant who sets the schedule
        - `queueForTagging` boolean — Whether the item should be queued for tagging
        - `bid` ParticipantPoolItemSchedulingBid — Bidding configuration for participant pool item scheduling
          - `maxPrice` number — Maximum price willing to pay for the scheduling slot
          - `currency` string — Currency code for the price (e.g., USD, EUR)
        - `counterBids` ParticipantPoolItemSchedulingCounterBid[] — Counter bids for this scheduling item
          - `id` string — Unique identifier for the counter bid
          - `counter` ParticipantPoolItemSchedulingBid, required — Bidding configuration for participant pool item scheduling
            - `maxPrice` number — Maximum price willing to pay for the scheduling slot
            - `currency` string — Currency code for the price (e.g., USD, EUR)
          - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED', required — Status of a counter bid for participant pool item scheduling
          - `publicId` string — Public identifier of the counter bidder
          - `name` string — Name of the counter bidder
          - `email` string — Email of the counter bidder
          - `createdAt` string, date-time — Timestamp when the counter bid was created
          - `updatedAt` string, date-time — Timestamp when the counter bid was last updated
          - `respondedAt` string, date-time — Timestamp when the counter bid was accepted or rejected
      - `ownershipRegistry` ParticipantPoolItemOwnershipRegistryItem[] — Registry of owners for this item
        - `role` 'OWNER' | 'ADMIN' | 'ENROLLEE' | 'ASSIGNER' | 'TAGGER', required — Role of a member within the participant pool
        - `publicId` string, required — Public identifier of the owner
        - `timestamp` string, date-time — When this ownership change occurred
        - `reason` string — Optional reason for the ownership change
      - `assignmentRules` ParticipantPoolItemAssignmentRule[]
        - `ruleId` string
        - `metadata` unknown
      - `participantPoolName` string
    - `attachmentRequests` ESignatureSignerAttachmentRequest[]
      - `id` string
      - `name` string, required
      - `description` string
      - `isOptional` boolean — Set to true if the request is optional
      - `isConfidential` boolean — Set to true if the attachment should not be shared with other signers; only the owner
    - `specialRoles` ESignatureSignerSpecialRoleEnum[]
    - `viewRestrictions` ESignatureSignerViewRestrictionEnum[]
  - `ccRecipients` ESignatureCCRecipient[]
    - `id` string
    - `name` string, required
    - `email` string, required
    - `specialRoles` ESignatureCCRecipientSpecialRoleEnum[]
  - `orderedSigners` boolean — Signers are sent by order
  - `status` 'ACTIVE' | 'CANCELLED' | 'COMPLETED' | 'DECLINED' | 'DRAFT' | 'LIVE' | 'LIVE_EDITING' | 'PREPARED' | 'PROCESSING' | 'SENT' | 'SCHEDULING' | 'SCHEDULED' | 'LOCKED_FOR_REVIEW'
  - `kind` 'IN_PERSON' | 'LIVE' | 'STANDARD'
  - `schedulingDetails` ESignatureSchedulingDetails
    - `timezone` string — Timezone used to format the date in the notifications. Timezone must be a valid [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
    - `date` string — The start time in ISO 8601 format. The format of is always 24 or 27 characters long `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
    - `durationInMinutes` integer — Duration
  - `attachments` ESignatureAttachment[]
    - `id` string, required
    - `filename` string, required
    - `filetype` string, required
    - `isConfidential` boolean
    - `ownerId` string, required — Public id or signer
    - `requestId` string — Id of the attachment request id that this fulfills
  - `jointSignersGroups` ESignatureJointSignersGroup[]
    - `id` string
    - `signerIds` string[], required
  - `recordedLiveESignature` boolean
  - `advancedOptions` ESignatureAdvancedOptions
    - `disableRepeatEntries` boolean
    - `penColor` 'SIGNER_SELECTED_COLOR' | 'BLACK' | 'BLUE' | 'RED' | 'GREEN'
    - `signatureTypes` SignatureTypeEnum[]
    - `notifications` ESignatureAdvancedOptionsNotificationItem[] — Settings for notification regarding this eSignature package
      - `event` union
        - 'ACTIVATED' | 'CANCELLED' | 'REDRAFTED' | 'COMPLETED' | 'DECLINED' | 'DELIVERY_FAILED' | 'DISABLE_RECORDING' | 'ENABLE_REPEAT_ENTRIES' | 'DISABLE_REPEAT_ENTRIES' | 'ENABLE_RECORDING' | 'LIVE_EDITING_STARTED' | 'LIVE_EDITING_FINISHED' | 'JOINT_SIGNERS_GROUP_CREATED' | 'JOINT_SIGNERS_GROUP_REMOVED' | 'LIVE_STARTED' | 'LIVE_ENDED' | 'LOCKED_FOR_REVIEW' | 'UNLOCKED_FROM_REVIEW' | 'OBSERVER_INVITED' | 'OBSERVER_REMOVED' | 'PREPARED' | 'REMINDER' | 'REMINDER_BY_TEXT_MESSAGE' | 'RESCHEDULED' | 'SENT' | 'SCHEDULED' | 'SIGNED' | 'SIGNER_ADDED' | 'SIGNER_REMOVED' | 'TRANSFERRED' | 'VIEWED'
        - 'EVENTS.ALL'
      - `participantId` union — This is the signerId, ownerId, or agreemaId of (essentially their participant id), Special participant IDs include, SIGNERS.ALL, which applies to all singers.
        - 'SIGNERS.ALL' | 'OBSERVERS.ALL' | 'PREPARERS.ALL' | 'PARTICIPANTS.ALL'
        - string
      - `enabled` boolean
    - `exitRedirectUriConfigurations` ESignatureAdvancedOptionsExitRedirectUriConfigItem[] — Settings for exit redirect uri for this eSignature package
      - `redirectUri` string — URI when the participant is exiting the signing ceremony
      - `participantId` union
        - 'OWNER' | 'SIGNER' | 'CC_RECIPIENT' | 'ARCHIVED_CC_RECIPIENT' | 'ARCHIVED_SIGNER' | 'ARCHIVED_OWNER'
        - string — This is the signerId or ownerId, or agreemaId
    - `resetENotaryAuthAtEntry` boolean — Reset the eNotary authentication at each entry
    - `cancelAtENotaryAuthFailure` boolean — Cancel the eSignature package if one of the eNotary validation fails
    - `inlineWebhook` InlineWebhook — unresolved $ref
    - `liveCeremonyLocks` ESignatureAdvancedOptionsLiveCeremonyLockEnum[]
  - `packageFolderId` string — Package folder that the esp is part of
  - `eNotaryPackageId` string — Id of the applicable eNotaryPackage
  - `customBrandItemId` string — Id of the applicable custom brand item to apply to this eSignature package

---

[API](https://skmtc.net/pactima/apis/esignature-packages-api.md) · [All operations](https://skmtc.net/pactima/apis/esignature-packages-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pactima/esignature-packages-api/revisions/1570128383ef/schema)