Create a note on a customer record

POST

/v1/customers/{customerId}/notes

Creates a free-text note attached to the specified customer. The note is immediately visible to office staff within the FieldEdge customer record.

Required scope: customers:write

Request

Authorization

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Note created successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.fieldedge.com/open-api/v1/customers//notes' \
--header 'Content-Type: application/json' \
--data '{
    "note": "CRM qualification note: customer expressed strong interest in annual maintenance plan."
}'

Response Example

201 - Sample response returned after creating a customer note

{
    "data": {
        "noteId": "a3f1b2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
        "customerId": "9f1a6b1c-3a3e-4b91-9a2f-2c6a9fbb1234",
        "note": "CRM qualification note: customer expressed strong interest in annual maintenance plan.",
        "createdAt": "2026-02-09T10:15:30Z"
    }
}

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

Retrieve attachments for a customer

Retrieve all notes for a customer