Skip to main content
POST
Create Party

Authorizations

Authorization
string
header
required

Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)

Body

application/json
users
object[]
required

Wraps the party in an array — only one entry is ever sent.

userType
enum<string>
required
Available options:
customer,
employee,
vendor
method
string
required
Example:

"Create"

action
string
required
Example:

"Create Parties"

apiVersion
string
required
Example:

"v2"

Response

200 - application/json

Party created, or a validation error

success
boolean
data
object

On failure, may be a structured validation-error object.

message

A string, or an array of objects each carrying a message.

statusCode
integer
error
unknown