Fieldmotion API Getting started

Customers

Set customer callback notes

POST /a/Customer_setCallbackNotes

Store or clear the free-form notes associated with one customer callback.

When to use this endpoint

Use Customer_setCallbackNotes to maintain explanatory text alongside a customer callback reminder.

It does not create, schedule, or send a reminder; it only changes the customer column.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler performs no additional page or role-permission check.

The lookup and any write use the authenticated tenant; an ID from another tenant cannot be addressed through this call.

Parameters

ParameterTypeRequiredDescription
idInteger stringYesCustomer to update; it must convert to a positive integer.
valStringYesCallback notes. A truthy string is stored verbatim; blank and "0" are stored as SQL null.

Example request

$result = FM_api('Customer_setCallbackNotes', [
	'id' => '1088',
	'val' => 'Confirm access arrangements before visiting.',
]);

Example response

{
  "ok": 1
}

A loosely equal value returns {"ok":"1","msg":"value already set"}, with a string ok.

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
{"error":"missing or invalid parameter: id"}id is absent or not a positive integer.
{"error":"missing or invalid parameter: val"}val was omitted; a present blank value clears the column.
{"error":"customer does not exist"}No matching customer row exists.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • The lookup has no active/deleted filter.
  • There is no length or content validation, and the no-change test uses loose comparison.
  • The value is independent of the callback date: updating or clearing it does not alter callback.
  • This is a single-record mutation; it provides no list filtering or pagination.

Side effects

  • A real change updates callback_notes, last_edited, and edited_uuid, then writes a customer audit-log entry.
  • It does not explicitly invalidate the customer cache or fire Customer_edit.

See it in Fieldmotion

CRM1

No direct production CRM1 caller was found. Use a signed request to exercise this focused setter; the callback date field in the edit popup uses a different endpoint.

CRM2

No direct production CRM2 caller was found. CRM2 uses its layout-driven customer update contract.

Related endpoints