Skip to main content
PATCH
/
parties
/
{partyId}
Update party details
curl --request PATCH \
  --url https://api.venlyfinance.com/v1/parties/{partyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 0,
  "firstName": "Janet",
  "lastName": "Doe"
}
'
{
  "success": true,
  "result": {
    "id": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
    "externalId": "user-12345",
    "partyType": "INDIVIDUAL",
    "status": "ACTIVE",
    "firstName": "Janet",
    "lastName": "Doe",
    "address": {
      "addressLine1": "1 Example Street",
      "city": "Amsterdam",
      "postalCode": "1011AB",
      "country": "NL"
    },
    "createdAt": "2026-01-15T09:30:00",
    "updatedAt": "2026-01-15T09:30:00",
    "version": 0
  }
}
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

​
Authorization
string
header
required

OAuth2 client credentials flow. Token endpoints:

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
​
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.