objects

Create /objects

Create an object. Required: name and either contact (client UUID) or lead (lead UUID, when enabled for tenant). Optional: status (defaults to tenant default when omitted), serial number, active, contact person, contract, project, subdivision, responsible persons, types, address fields, dates, note, description, organization, and custom fields. Returns record with the detail projection.

POST

/objects

Create /objects

curl --request POST \
  --url https://default.hannacrm.app/api/v4/objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": "<string>",
  "address": "<string>",
  "city": "<string>",
  "contact": "<string>",
  "contact_person": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contract": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "description": "<string>",
  "installation_date": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "name": "<string>",
  "note": "<string>",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "responsible_person": [
    "<string>"
  ],
  "serial_no": "<string>",
  "status": "<string>",
  "subdivision": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": [
    "<string>"
  ],
  "warranty_until_date": "<string>"
}
'

{
  "record": {
    "active": "<string>",
    "address": "<string>",
    "city": "<string>",
    "contact": [
      {}
    ],
    "contact_person": [
      {}
    ],
    "contract": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "description": "<string>",
    "installation_date": "2023-11-07T05:31:56Z",
    "latitude": "<string>",
    "lead": [
      {}
    ],
    "longitude": "<string>",
    "name": "<string>",
    "note": "<string>",
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "project": [
      {}
    ],
    "responsible_person": [
      {}
    ],
    "serial_no": "<string>",
    "status": [
      {}
    ],
    "subdivision": [
      {}
    ],
    "type": [
      {}
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>",
    "warranty_until_date": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorizationstringheaderrequired

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

Body

activestring

Whether the object is active.

addressstring

Street address.

citystring

City.

contactstring

Client UUID (required on create if lead is omitted).

contact_personstring

Client contact person UUID.

contractstring

Contract UUID.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

descriptionstring

Object description.

installation_datestring

Installation date (Y-m-d).

latitudestring

Latitude.

longitudestring

Longitude.

namestringrequired

Object name.

notestring

Internal note.

organizationstring

Organization UUID.

projectstring

Project UUID.

responsible_personstring[]

Responsible person staff UUIDs.

serial_nostring

Serial number.

statusstring

Object status UUID or code_name. Uses tenant default status when omitted on create.

subdivisionstring

Client subdivision UUID.

typestring[]

Object type UUIDs.

warranty_until_datestring

Warranty end date (Y-m-d).

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