Skip to content

Update a specific party

PUT
/parties/{id}
curl --request PUT \
--url http://localhost:8000/api/v1/parties/1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "client_id": "example", "name": "Jane Doe", "type": "individual, organization,business,partnership, non_profit,government_agency, educational_institution,healthcare_provider", "description": "income from John Doe", "icon": "example", "icon_type": "example", "updated_at": "2026-04-15T12:00:00Z" }'
id
required
integer
Media type application/json
object
client_id

Unique identifier for your local client

string
name
string
Example
Jane Doe
type
string
Example
individual, organization,business,partnership, non_profit,government_agency, educational_institution,healthcare_provider
description
string
Example
income from John Doe
icon

The icon of the party (file or icon string)

string
icon_type

The type of the icon (icon or emoji or image)

string
updated_at
string format: date-time

Party updated successfully

Media type application/json
object
id

ID of the party

integer
type

Type of the party

string
name

Name of the party

string
description

Description of the party

string
icon

Party icon

object
id

ID of the icon

integer
path

Image of the icon

string
type

Type of icon( image or icon or emoji)

string
Example generated
{
"id": 1,
"type": "example",
"name": "example",
"description": "example",
"icon": {
"id": 1,
"path": "example",
"type": "example"
}
}

Invalid input

Unauthorized

Party not found

Server error