Skip to content

Create a new party

POST
/parties
curl --request POST \
--url http://localhost:8000/api/v1/parties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "client_id": "245cb3df-df3a-428b-a908-e5f74b8d58a3:245cb3df-df3a-428b-a908-e5f74b8d58a4", "name": "John Doe", "type": "individual,organization,\n business,partnership,non_profit,\n government_agency,educational_institution,\n healthcare_provider", "description": "Incomes from John Doe", "icon": "example", "icon_type": "example", "created_at": "2026-04-15T12:00:00Z" }'
Media type application/json
object
client_id

Unique identifier for your local client

string format: string
Example
245cb3df-df3a-428b-a908-e5f74b8d58a3:245cb3df-df3a-428b-a908-e5f74b8d58a4
name
required
string
Example
John Doe
type
string
Example
individual,organization,
business,partnership,non_profit,
government_agency,educational_institution,
healthcare_provider
description
string
Example
Incomes 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
created_at
string format: date-time

Party created 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|Party already exists

Unauthorized

Server error