Skip to main content
Update a recipient

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Maximum string length: 500
organization_number
string | null

Registration identifier, at most 100 characters. Recognized country-specific formats and checksums are validated using the registration country, recognized prefix, or address country. Valid identifiers are stored canonically, preserving leading zeros and identifier families. Invalid supported identifiers and placeholders are rejected. Unsupported and format-only identifiers receive basic character validation without country inference. Null or blank clears the number.

Maximum string length: 100
org_country
string | null

Country issuing the organization number. Missing countries are inferred only after checksum validation, using a recognized prefix before the address country. Existing countries are preserved unless explicitly changed. Null clears the country and suppresses inference for this write; later ingestion may infer it again.

Pattern: ^([A-Za-z]{2})?$
email
string | null
Maximum string length: 320
website
string | null
Maximum string length: 2000
address
object | null

Response

Current canonical party master record. Invoice party fields remain captured invoice snapshots.

id
string<uuid>
required
name
string
required
organization_number
string | null
required
org_country
string | null
required

Country issuing the organization number; null when unknown.

email
string | null
required
website
string | null
required
address
object
required
domain
string | null
required

Derived company domain; not editable.

relationships
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required