Skip to main content
PATCH
Update party details
Requires scope: manage:parties — see Required scopes. Patches only the fields you send. Include the current version (from a prior read); a stale version returns 409 so you can refetch and retry (see Versioning). partyType cannot be changed after creation.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

partyId
string<uuid>
required

Unique party identifier

Body

application/json

Update party details. Only fields applicable to the party type can be updated. For Individuals: firstName, lastName, address. For Organisations: name, vatNumber, address.

version
integer<int64>
required

Current version of the party for optimistic locking

firstName
string

First name (Individual only)

Maximum string length: 100
lastName
string

Last name (Individual only)

Maximum string length: 100
name
string

Organisation name (Organisation only)

Maximum string length: 255
vatNumber
string

VAT number (Organisation only)

Maximum string length: 50
email
string<email> | null

Contact email for the party, kept as your own record. Optional — omitting it never blocks an onboarding. When an account holder is onboarded to a partner, the email travels only as far as Venly's verification case: the partner is given a Venly-controlled address instead, so its operational and pricing mail never reaches the party directly.

Maximum string length: 255
address
object

Standardized address format used across all endpoints

Response

Party updated

success
boolean

Indicates whether the request was successful

result
object

A party represents an Individual or Organisation that can hold accounts. The partyType field determines which additional fields are present.