Change the kind of the package

post https://rest.api.pactima.com/v1/e-signature-packages/{eSignaturePackageId}/actions/switch-kind

This endpoint is used to "re-trigger", i.e. change the particular kind of the package. Here are the conditions for trigger:\ - For LIVE packages, the status must be LIVE or SCHEDULED - For STANDARD packages, the status must be SENT, and - For IN_PERSON packages, the status must be ACTIVE or PREPARED

Response

Response body

object

string

required

isTestMode

boolean

title

string

required

description

string

documents

array of objects

documents

object

string

name

string

pageCount

number

entryPads

array of objects

entryPads

object

string

signerId

string

required

Id of the signer

type

string

required

signature initials stamp date text checkbox name notary_public_profile_info email

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

string

signers

array of objects

signers

object

string

name

string

required

string

required

phoneNumber

string

attachmentRequests

array of objects

attachmentRequests

object

string

name

string

required

description

string

isOptional

boolean

Defaults to false

Set to true if the request is optional

isConfidential

boolean

Defaults to true

Set to true if the attachment should not be shared with other signers; only the owner

specialRoles

array of strings

specialRoles

ccRecipients

array of objects

ccRecipients

object

string

name

string

required

string

required

specialRoles

array of strings

specialRoles

orderedSigners

boolean

Signers are sent by order

status

string

ACTIVE CANCELLED COMPLETED DECLINED DRAFT LIVE LIVE_EDITING PREPARED PROCESSING SENT SCHEDULED LOCKED_FOR_REVIEW

kind

string

IN_PERSON LIVE STANDARD

schedulingDetails

object

timezone

string

Timezone used to format the date in the notifications. Timezone must be a valid TZ database name

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

array of objects

attachments

object

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

array of objects

jointSignersGroups

object

string

signerIds

array of strings

required

signerIds*

recordedLiveESignature

boolean

advancedOptions

object

disableRepeatEntries

boolean

penColor

string

SIGNER_SELECTED_COLOR BLACK BLUE RED GREEN

signatureTypes

array of strings

signatureTypes

notifications

array of objects

Settings for notification regarding this eSignature package

notifications

object

event

participantId

This is the signerId, ownerId, or agreemaId of (essentially their participant id), Special participant IDs include, SIGNERS.ALL, which applies to all singers.

enabled

boolean

exitRedirectUriConfigurations

array of objects

Settings for exit redirect uri for this eSignature package

exitRedirectUriConfigurations

object

redirectUri

string

URI when the participant is exiting the signing ceremony

participantId

resetENotaryAuthAtEntry

boolean

Reset the eNotary authentication at each entry

cancelAtENotaryAuthFailure

boolean

Cancel the eSignature package if one of the eNotary validation fails

inlineWebhook

object

liveCeremonyLocks

array of strings

liveCeremonyLocks

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

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://rest.api.pactima.com/v1/e-signature-packages/eSignaturePackageId/actions/switch-kind \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
124
}
1
{
2
  "id": "string",
3
  "isTestMode": true,
4
  "title": "string",
5
  "description": "string",
6
  "documents": [
7
    {
8
      "id": "string",
9
      "name": "string",
10
      "pageCount": 0,
11
      "entryPads": [
12
        {
13
          "id": "string",
14
          "signerId": "string",
15
          "type": "signature",
16
          "left": 0,
17
          "top": 0,
18
          "height": 0,
19
          "width": 0,
20
          "pageIndex": 0,
21
          "isOptional": true
22
        }
23
      ]
24
    }
25
  ],

200Returns the eSignature package object if the action was successfully performed.