POST/api/v1/clients

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

tax_id_numberstring

notesstring

propertiesobject

payment_termsstring

billing_cyclestringRequired

Enum: weeklybi-weeklymonthlyquarterlysemi-annuallyannually

credit_limitnumber

≥ 0

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

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

tax_id_numberstringRequiredNullable

notesstringRequiredNullable

propertiesobject

industrystring

company_sizestring

annual_revenuestring

primary_contact_idstring <uuid>

primary_contact_namestring

statusstring

typestring

billing_addressstring

tax_idstring

notesstring

payment_termsstring

websitestring <uri>

parent_client_idstring <uuid>

parent_client_namestring

last_contact_datestring <date-time>

logostring

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

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.

POST /api/v1/clients

cURL

curl -X POST "https://algapsa.com/api/v1/clients" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_name": "x",
  "phone_no": "string",
  "email": "user@example.com",
  "url": "https://example.com",
  "address": "string",
  "client_type": "string",
  "tax_id_number": "string",
  "notes": "string",
  "properties": {},
  "payment_terms": "string",
  "billing_cycle": "weekly",
  "credit_limit": 0,
  "preferred_payment_method": "string",
  "auto_invoice": false,
  "invoice_delivery_method": "email",
  "region_code": "string",
  "is_tax_exempt": false,
  "tax_exemption_certificate": "string",
  "timezone": "string",
  "invoice_template_id": "01HN2K7VRB9PQ3Y0000000000",
  "billing_contact_id": "01HN2K7VRB9PQ3Y0000000000",
  "billing_email": "user@example.com",
  "account_manager_id": "01HN2K7VRB9PQ3Y0000000000",
  "is_inactive": false,
  "tags": [
    "string"
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_name": "x",
    "phone_no": "string",
    "email": "user@example.com",
    "url": "https://example.com",
    "address": "string",
    "client_type": "string",
    "tax_id_number": "string",
    "notes": "string",
    "properties": {},
    "payment_terms": "string",
    "billing_cycle": "weekly",
    "credit_limit": 0,
    "preferred_payment_method": "string",
    "auto_invoice": false,
    "invoice_delivery_method": "email",
    "region_code": "string",
    "is_tax_exempt": false,
    "tax_exemption_certificate": "string",
    "timezone": "string",
    "invoice_template_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_contact_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_email": "user@example.com",
    "account_manager_id": "01HN2K7VRB9PQ3Y0000000000",
    "is_inactive": false,
    "tags": [
      "string"
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/clients");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_name"": ""x"",
  ""phone_no"": ""string"",
  ""email"": ""user@example.com"",
  ""url"": ""https://example.com"",
  ""address"": ""string"",
  ""client_type"": ""string"",
  ""tax_id_number"": ""string"",
  ""notes"": ""string"",
  ""properties"": {},
  ""payment_terms"": ""string"",
  ""billing_cycle"": ""weekly"",
  ""credit_limit"": 0,
  ""preferred_payment_method"": ""string"",
  ""auto_invoice"": false,
  ""invoice_delivery_method"": ""email"",
  ""region_code"": ""string"",
  ""is_tax_exempt"": false,
  ""tax_exemption_certificate"": ""string"",
  ""timezone"": ""string"",
  ""invoice_template_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""billing_contact_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""billing_email"": ""user@example.com"",
  ""account_manager_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""is_inactive"": false,
  ""tags"": [
    ""string""
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "client_name": "string",
    "phone_no": "string",
    "credit_balance": 0,
    "email": "string",
    "url": "string",
    "address": "string",
    "created_at": "2026-04-18T15:22:14Z",
    "updated_at": "2026-04-18T15:22:14Z",
    "is_inactive": false,
    "client_type": "string",
    "tax_id_number": "string",
    "notes": "string",
    "properties": {
      "industry": "string",
      "company_size": "string",
      "annual_revenue": "string",
      "primary_contact_id": "01HN2K7VRB9PQ3Y0000000000",
      "primary_contact_name": "string",
      "status": "string",
      "type": "string",
      "billing_address": "string",
      "tax_id": "string",
      "notes": "string",
      "payment_terms": "string",
      "website": "https://example.com",
      "parent_client_id": "01HN2K7VRB9PQ3Y0000000000",
      "parent_client_name": "string",
      "last_contact_date": "2026-04-18T15:22:14Z",
      "logo": "string"
    },
    "payment_terms": "string",
    "billing_cycle": "weekly",
    "credit_limit": 0,
    "preferred_payment_method": "string",
    "auto_invoice": false,
    "invoice_delivery_method": "string",
    "region_code": "string",
    "is_tax_exempt": false,
    "tax_exemption_certificate": "string",
    "timezone": "string",
    "invoice_template_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_contact_id": "01HN2K7VRB9PQ3Y0000000000",
    "billing_email": "string",
    "account_manager_id": "01HN2K7VRB9PQ3Y0000000000",
    "account_manager_full_name": "string",
    "logoUrl": "string",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "tags": [
      "string"
    ]
  },
  "meta": {}
}