Skip to main content
PATCH
Update a template party
You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required
partyId
string
required

Body

application/json

Body

Update template party request

name
string
email
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string
companyName
string
companyRole
string
companyOrgNumber
string
companyId
string
externalId
string
ssn
string
country
string

ISO 3166-1 alpha-3 country code (e.g. SWE)

role
any

Party role: SIGNER, ORGANIZER, or REVIEWER. (ACCEPTOR is deprecated and treated as SIGNER.)

signingOrder
number | null
deliveryMethod
enum<string>
Available options:
EMAIL,
SMS,
NONE,
IN_APP
requiredSignature
enum<string>
Available options:
NONE,
DRAWING,
SE_BANKID,
MANUAL,
CLICK_TO_SIGN,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
NO_QES,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN
twoStepVerification
enum<string>
Available options:
NONE,
SMS_BEFORE_SIGNING,
EMAIL_BEFORE_SIGNING,
PIN_BEFORE_SIGNING,
SE_BANKID_BEFORE_SIGNING,
NO_BANKID_BIOMETRIC_BEFORE_SIGNING,
NO_BANKID_HIGH_BEFORE_SIGNING,
DK_MITID_BEFORE_SIGNING,
DK_MITID_ERHVERV_BEFORE_SIGNING,
FI_FTN_BEFORE_SIGNING,
NL_IDIN_BEFORE_SIGNING

Response

200

id
string
required

Unique template party identifier

templateId
string
required

Template ID this party belongs to

name
string
required

Party name

type
enum<string>
required

Party type: INDIVIDUAL or COMPANY

Available options:
INDIVIDUAL,
COMPANY
role
enum<string>
required

Party role: SIGNER, ORGANIZER, or REVIEWER

Available options:
SIGNER,
ORGANIZER,
REVIEWER
deliveryMethod
enum<string>
required

Default delivery method

Available options:
EMAIL,
SMS,
NONE,
IN_APP
twoStepVerification
enum<string>
required

Default two-step verification

Available options:
NONE,
PIN_BEFORE_SIGNING,
SMS_BEFORE_SIGNING,
EMAIL_BEFORE_SIGNING,
BANKID_BEFORE_SIGNING,
NO_BANKID_BIOMETRIC_BEFORE_SIGNING,
NO_BANKID_HIGH_BEFORE_SIGNING,
DK_MITID_BEFORE_SIGNING,
DK_MITID_ERHVERV_BEFORE_SIGNING,
FI_FTN_BEFORE_SIGNING,
NL_IDIN_BEFORE_SIGNING
createdAt
any
required
updatedAt
any
required
email
string | null

Party email address

phone
string | null

Party phone number

signingOrder
number | null

Order for sequential signing

contactId
string | null

Linked contact ID

companyId
string | null

Linked company ID

companyName
string | null

Company name

companyRole
string | null

Role within the company

companyOrgNumber
string | null

Company organization number

externalId
string | null

External reference ID

ssn
string | null

Swedish personal number (personnummer)

country
string | null

ISO 3166-1 alpha-3 country code (e.g. SWE)

requiredSignature
enum<string> | null

Default required signature type

Available options:
NONE,
DRAWING,
BANKID,
MANUAL,
CLICK_TO_SIGN,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
NO_QES,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN