Creates a new customer

POST

/v1/customers

Creates a new customer record with primary contact details, address information, preferred contact methods, and marketing opt-in preferences.

Required scope: customers:write

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Customer created successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://dev.api.fieldedge.com/open-api/v1/customers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Sam",
    "lastName": "Wilson",
    "companyName": "Stark Industries",
    "email": "sam.wilson@test.com",
    "phoneNumber": "+14155552671",
    "preferredContactMethods": [
        "Email",
        "Phone"
    ],
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "Dallas",
    "state": "TX",
    "zip": "75001",
    "marketingEmailOptIn": true,
    "marketingSmsOptIn": false
}'

Response Example

201 - Sample response returned after creating a customer

{
    "data": {
        "customerId": "9f1a6b1c-3a3e-4b91-9a2f-2c6a9fbb1234",
        "createdAt": "2026-02-09T10:15:30Z"
    }
}

Modified at 2026-08-27 11:27:54

Fetches lead details based on the provided lead identifier.

Updates an existing customer