Skip to Content
Templates

Update a template party

PATCH
/api/v1/templates/{id}/parties/{partyId}

Updates a template party. A property you leave out stays unchanged, and null clears it. A locked template can't be changed: the request fails with an HTTP 409 Conflict status code and the code INVALID_STATE.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The template ID.

partyId*string

The party ID.

Header Parameters

Sajn-Version?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.

Value in"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.

Lengthlength <= 255

Request Body

Body

application/json
  1. body

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

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

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?|

National identity number, such as a Swedish personnummer

country?|

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

role?string

Party role: SIGNER, ORGANIZER, or REVIEWER.

Value in"SIGNER""ORGANIZER""REVIEWER"
signingOrder?number|null
delivery?array<>

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.

signatureMethod?|

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.

Value in"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""ZEALID_QES"null
signVerification?|

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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null

Response Body

200

application/json
  1. response
id*string

Unique template party identifier

templateId*string

Template ID this party belongs to

name*string

Party name

email*|

Party email address

phone*|

Party phone number

type*string

Party type: INDIVIDUAL or COMPANY

Value in"INDIVIDUAL""COMPANY"
role*string

Party role: SIGNER, ORGANIZER, or REVIEWER

Value in"SIGNER""ORGANIZER""REVIEWER"
signingOrder*|

Order for sequential signing

contactId*|

Linked contact ID

company*|

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

externalId*|

External reference ID

nationalId*|

National identity number, such as a Swedish personnummer

country*|

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

signatureMethod*|

Default signature method

Value in"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""ZEALID_QES"null
delivery*array<>

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.

signVerification*|

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.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null
createdAt*string

When the party was added to the template

Formatdate-time
updatedAt*string

When the party was last changed

Formatdate-time
Example Request
curl -X PATCH 'https://app.sajn.se/api/v1/templates/cm4k2x9p10008abcd1234efgh/parties/cm4k2x9p10004abcd1234efgh' \  -H 'Content-Type: application/json' \  -d '{  "name": "Den anställde",  "signatureMethod": "SE_BANKID"}'
Example Response
{  "id": "cm4k2x9p10004abcd1234efgh",  "templateId": "cm4k2x9p10008abcd1234efgh",  "name": "Kai Lindqvist",  "email": "kai@example.com",  "phone": "+46701740605",  "type": "INDIVIDUAL",  "role": "SIGNER",  "signingOrder": 1,  "contactId": "cm4k2x9p10006abcd1234efgh",  "company": null,  "externalId": "HR-2026-0142",  "nationalId": "191212121212",  "country": "SE",  "signatureMethod": "SE_BANKID",  "delivery": [    "EMAIL"  ],  "signVerification": "PIN",  "createdAt": "2026-09-28T09:12:00.000Z",  "updatedAt": "2026-09-28T09:15:00.000Z"}

Was this page helpful?