Skip to main content
PATCH
Update a template party

Authorizations

Authorization
string
header
required

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

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

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

The template ID.

partyId
string
required

The party ID.

Body

application/json

Body

Update template party request. A property you leave out stays unchanged, and null clears it.

name
string
email
string<email> | null
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string | null
company
object | null

The company the party signs for. A key you leave out keeps its value. Pass null to clear every company field.

externalId
string | null
nationalId
string | null

National identity number, such as a Swedish personnummer

country
string | null

ISO 3166-1 alpha-2 country code of the party, such as SE or DE

role
enum<string>

Party role: SIGNER, ORGANIZER, or REVIEWER.

Available options:
SIGNER,
ORGANIZER,
REVIEWER
signingOrder
number | null
delivery
enum<string>[]

How the party gets the invitation: ["EMAIL"], ["SMS"], ["EMAIL", "SMS"] for both, or ["IN_APP"] to sign in person on your device. [] sends nothing, so you share the signing URL yourself. Each channel needs the matching contact detail.

Available options:
EMAIL,
SMS,
IN_APP
signatureMethod
enum<string> | null

How the party signs: DRAWING, SE_BANKID, CLICK_TO_SIGN, or another eID. Call GET /api/v1/helpers/signature-methods for the methods your account can use. Defaults to the workspace setting.

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,
null
signVerification
enum<string> | null

Verification the party passes before signing: PIN, SMS, EMAIL, or an eID such as SE_BANKID. null means none. Call GET /api/v1/helpers/two-step-verifications for the methods your account can use.

Available options:
PIN,
SMS,
EMAIL,
SE_BANKID,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN,
null

Response

200

id
string
required

Unique template party identifier

templateId
string
required

Template ID this party belongs to

name
string
required

Party name

email
string | null
required

Party email address

phone
string | null
required

Party phone number

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
signingOrder
number | null
required

Order for sequential signing

contactId
string | null
required

Linked contact ID

company
object | null
required

The company the party signs for, or null for a private individual

externalId
string | null
required

External reference ID

nationalId
string | null
required

National identity number, such as a Swedish personnummer

country
string | null
required

ISO 3166-1 alpha-2 country code of the party, such as SE

signatureMethod
enum<string> | null
required

Default signature method

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,
null
delivery
enum<string>[]
required

How the party gets the invitation: ["EMAIL"], ["SMS"], ["EMAIL", "SMS"] for both, or ["IN_APP"] to sign in person on your device. [] sends nothing, so you share the signing URL yourself. Each channel needs the matching contact detail.

Available options:
EMAIL,
SMS,
IN_APP
signVerification
enum<string> | null
required

Verification the party passes before signing: PIN, SMS, EMAIL, or an eID such as SE_BANKID. null means none. Call GET /api/v1/helpers/two-step-verifications for the methods your account can use.

Available options:
PIN,
SMS,
EMAIL,
SE_BANKID,
NO_BANKID_BIOMETRIC,
NO_BANKID_HIGH,
DK_MITID,
DK_MITID_ERHVERV,
FI_FTN,
NL_IDIN,
null
createdAt
string<date-time>
required

When the party was added to the template

updatedAt
string<date-time>
required

When the party was last changed