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

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. Optional, but supply a real one up front for an individual on a self-custody account.

When an account holder is onboarded to a partner their email is forwarded with the case. If the party has none, a synthetic <case-id>@venlyfinance.com address is used so onboarding still proceeds — and because the partner stores that email write-once, adding a real address later does not replace the synthetic one. There is no way to correct it afterwards.

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.