clients

Create /clients

Create a client. Required: company. Optional: company code, VAT, contact details, address, legal type, types, categories, contact levels, responsible staff, organization. Returns record with the detail projection.

POST

/clients

Create /clients

curl --request POST \
  --url https://default.hannacrm.app/api/v4/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "<string>",
  "client_categories": [
    "<string>"
  ],
  "client_types": [
    "<string>"
  ],
  "company": "<string>",
  "company_code": "<string>",
  "country": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "customer_levels": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "email": "<string>",
  "legal_type": "<string>",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "<string>",
  "responsible": [
    "<string>"
  ],
  "state": "<string>",
  "street": "<string>",
  "vat_code": "<string>",
  "website": "<string>",
  "zip": "<string>"
}
'

{
  "record": {
    "address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "assigned_users": [
      {}
    ],
    "avg_salary": "<string>",
    "bank_account": "<string>",
    "billing_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "city": "<string>",
    "client_activities": [
      {}
    ],
    "client_categories": [
      {}
    ],
    "client_types": [
      {}
    ],
    "company": "<string>",
    "company_code": "<string>",
    "country": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "customer_levels": [
      {}
    ],
    "datecreated": "2023-11-07T05:31:56Z",
    "debt_balance": "<string>",
    "debt_overdue_balance": "<string>",
    "default_language": "<string>",
    "description": "<string>",
    "email": "<string>",
    "employees_count": "<string>",
    "is_send_invoice_due_reminders": "<string>",
    "last_contact": "2023-11-07T05:31:56Z",
    "legal_type": "<string>",
    "money_balance": "<string>",
    "organization": [
      {}
    ],
    "organization_default": "<string>",
    "phone": "<string>",
    "primary_contact": {
      "email": "<string>",
      "full_name": "<string>",
      "phone": "<string>",
      "uuid": "<string>"
    },
    "sale_potential": "<string>",
    "send_invoice_due_reminders_after_days": "<string>",
    "shipping_address": {
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "source_name": "<string>",

Side effect: unless the client already has one, a primary contact person is created alongside the client (same behaviour as creating a customer in the CRM UI). Its first/last name comes from company split on the first space, and it inherits phone and email. That contact is also returned by GET /contacts, so a 'New Contact' trigger fires for it.

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

citystring

client_categoriesstring[]

Customer group UUIDs or code_name values.

client_typesstring[]

Customer type UUIDs or code_name values.

companystringrequired

Company or person name.

company_codestring

Company registration code.

countrystring

Country UUID.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

customer_levelsstring[]

Contact level picklist value UUIDs (contacts/customer_level). Discover values via GET /api/v4/picklists. Pass [] to clear.

descriptionstring

emailstring

Email address.

legal_typestring

Legal type: company or person. Defaults to company when omitted on create.

organizationstring

Organization UUID.

phonestring

Phone number.

responsiblestring[]

Responsible staff UUIDs.

statestring

streetstring

vat_codestring

VAT code.

websitestring

zipstring

Response

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team