Upsert customer

PUT

/customers/

Creates or updates a customer.

Looks up an existing customer by external ID. If a match is found, updates
it; otherwise creates a new customer.

External ID is required.

Only the fields provided are changed; omitted fields remain unchanged.

Request

Body Params application/jsonRequired

Example

{
    "business_name": "Northwind HVAC Services",
    "mobile_number": "+61 412 345 678",
    "email": "dispatch@hvac.example.com",
    "cc_email_list": [
        "accounts@hvac.example.com"
    ],
    "address": "12 Cooling Way, Brisbane QLD 4000",
    "external_id": "CUST-1001",
    "business_number": "12 345 678 901",
    "notes": "Preferred HVAC contractor for all sites.",
    "status": "67",
    "payment_term": "80",
    "business_entity": "66",
    "custom_fields": [
        {
            "field": "1",
            "value": "Premium"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://app.fieldinsight.com/public-api//customers/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "business_name": "Northwind HVAC Services",
    "mobile_number": "+61 412 345 678",
    "email": "dispatch@hvac.example.com",
    "cc_email_list": [
        "accounts@hvac.example.com"
    ],
    "address": "12 Cooling Way, Brisbane QLD 4000",
    "external_id": "CUST-1001",
    "business_number": "12 345 678 901",
    "notes": "Preferred HVAC contractor for all sites.",
    "status": "67",
    "payment_term": "80",
    "business_entity": "66",
    "custom_fields": [
        {
            "field": "1",
            "value": "Premium"
        }
    ]
}'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

{
    "id": "4001"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429

Modified at 2026-10-30 03:40:11

Get customers

Patch customer