Upsert contact

PUT

/contacts/

Creates or updates a contact.

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

External ID is required.

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

Request

Body Params application/jsonRequired

Example

{
    "external_id": "CONTACT-1001",
    "first_name": "Oliver",
    "last_name": "Bennett",
    "business_name": "Northwind HVAC Services",
    "mobile_number": "+61 412 345 678",
    "landline_number": "+61 7 3123 4567",
    "email": "oliver.bennett@hvac.example.com",
    "cc_email_list": [
        "dispatch@hvac.example.com"
    ],
    "address": "12 Cooling Way, Brisbane QLD 4000",
    "notes": "Prefers contact before 9am.",
    "custom_fields": [
        {
            "field": "1",
            "value": "Morning"
        }
    ]
}

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//contacts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_id": "CONTACT-1001",
    "first_name": "Oliver",
    "last_name": "Bennett",
    "business_name": "Northwind HVAC Services",
    "mobile_number": "+61 412 345 678",
    "landline_number": "+61 7 3123 4567",
    "email": "oliver.bennett@hvac.example.com",
    "cc_email_list": [
        "dispatch@hvac.example.com"
    ],
    "address": "12 Cooling Way, Brisbane QLD 4000",
    "notes": "Prefers contact before 9am.",
    "custom_fields": [
        {
            "field": "1",
            "value": "Morning"
        }
    ]
}'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

{
    "id": "1001"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429

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

Create contact

Patch contact