Update a template party

Update an existing template party.

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

Update a template party

cURL

curl --request PATCH \
  --url https://app.sajn.se/api/v1/templates/{id}/parties/{partyId} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "name": "<string>",
  "email": "[e-mail]",
  "phone": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "companyId": "<string>",
  "externalId": "<string>",
  "ssn": "<string>",
  "country": "<string>",
  "signingOrder": 123
}
'

200

{
  "id": "<string>",
  "templateId": "<string>",
  "name": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "email": "<string>",
  "phone": "<string>",
  "signingOrder": 123,
  "contactId": "<string>",
  "companyId": "<string>",
  "companyName": "<string>",
  "companyRole": "<string>",
  "companyOrgNumber": "<string>",
  "externalId": "<string>",
  "ssn": "<string>",
  "country": "<string>"
}

Headers

authorization · string · required

Bearer token for API authentication

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 · enum<string>

Available options: SIGNER, ORGANIZER, REVIEWER, ACCEPTOR

signingOrder · number | null

deliveryMethod · enum<string>

Available options: EMAIL, SMS, NONE

requiredSignature · enum<string>

Available options: NONE, DRAWING, BANKID, MANUAL, CLICK_TO_SIGN

twoStepVerification · enum<string>

Available options: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING

Response

200

application/json

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, REVIEWER, or ACCEPTOR

Available options: SIGNER, ORGANIZER, REVIEWER, ACCEPTOR

deliveryMethod · enum<string> · required

Default delivery method

Available options: EMAIL, SMS, NONE

twoStepVerification · enum<string> · required

Default two-step verification

Available options: NONE, SMS_BEFORE_SIGNING, EMAIL_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