Clients API
POST/api/v1/clients
Product availabilityAlgaPSAAlgaDesk

Create client

Inherited ApiBaseController create route for clients. Requires API-key auth and client:create permission.

RBAC · client

Request body

Content type: application/json · schema ClientBody

client_namestringRequired
min length 1 · max length 255
phone_nostring
emailstring <email>
urlstring <uri>
addressstring
client_typestring
Enum: companyindividual
tax_id_numberstring
notesstring
propertiesobject
tax_idstringDeprecated
Deprecated legacy input. Send tax_id_number instead.
payment_termsstring
billing_cyclestringRequired
Enum: weeklybi-weeklymonthlyquarterlysemi-annuallyannually
credit_limitnumber
≥ 0
default_currency_codestring
min length 3 · max length 3
preferred_payment_methodstring
auto_invoiceboolean
invoice_delivery_methodstring
Enum: emailmailportal
region_codestring
is_tax_exemptboolean
tax_exemption_certificatestring
timezonestring
invoice_template_idstring <uuid>
billing_contact_idstring <uuid>
billing_emailstring <email>
account_manager_idstring <uuid>
is_inactiveboolean
lifecycle_statusstring
Relationship lifecycle (default active on create). The Clients list shows only active clients by default, so prospect and former clients are hidden there until the user changes the Lifecycle filter. Only send prospect or former when the user explicitly asks for that status.
Enum: prospectactiveformer
tagsarray of string
itemsstring

Response body

Success response 201 · schema ClientEnvelope

dataobjectRequired
client_idstring <uuid>Required
client_namestringRequired
phone_nostringRequiredNullable
credit_balancenumberRequired
emailstringRequiredNullable
urlstringRequiredNullable
addressstringRequiredNullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
is_inactivebooleanRequired
client_typestringRequiredNullable
Enum: companyindividualnull
tax_id_numberstringRequiredNullable
notesstringRequiredNullable
propertiesobject
industrystring
company_sizestring
annual_revenuestring
primary_contact_idstring <uuid>
primary_contact_namestring
statusstring
typestring
billing_addressstring
notesstring
payment_termsstring
websitestring
parent_client_idstring <uuid>
parent_client_namestring
last_contact_datestring <date-time>
logostring
defaultLocalestring
payment_termsstringRequiredNullable
billing_cyclestringRequired
Enum: weeklybi-weeklymonthlyquarterlysemi-annuallyannually
credit_limitnumberRequiredNullable
preferred_payment_methodstringRequiredNullable
auto_invoicebooleanRequired
invoice_delivery_methodstringRequiredNullable
region_codestringRequiredNullable
is_tax_exemptbooleanRequired
tax_exemption_certificatestringRequiredNullable
timezonestringRequiredNullable
invoice_template_idstring <uuid>RequiredNullable
billing_contact_idstring <uuid>RequiredNullable
billing_emailstringRequiredNullable
account_manager_idstring <uuid>RequiredNullable
account_manager_full_namestringNullable
client_sincestringNullable
lifecycle_statusstring
Enum: prospectactiveformer
logoUrlstringNullable
tenantstring <uuid>Required
tagsarray of string
itemsstring
metaobject

Response codes

201
Client created.
400
Invalid request payload.
401
API key missing/invalid or key user not found.
403
Permission denied for client create.
500
Unexpected client creation failure.