Fieldmotion API Getting started

Customers

Set customer street address line 1

POST /a/Customer_setStreet1

Change or clear the first street-address line while attempting to preserve customer address history.

When to use this endpoint

Use Customer_setStreet1 for a focused edit to the first address line of a known customer.

Retrieve the assembled address first when a caller must reason about parent or historical address context.

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.
valStringYesNew first street-address line, trimmed before comparison and storage. Present blank clears it; no length limit is enforced here.

Example request

$result = FM_api('Customer_setStreet1', [
	'id' => '1088',
	'val' => '14 Harbour Road',
]);

Example response

{
  "ok": 1
}

An unchanged trimmed value returns {"ok":1,"msg":"no change needed"}.

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 invalid.
{"error":"missing or invalid parameter: val"}val was omitted.
{"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 does not filter inactive or soft-deleted rows.
  • The endpoint applies no street format or length validation.
  • History/cache work and the final customer update are not one transaction.
  • This is a single-record mutation; it provides no list filtering or pagination.

Side effects

  • Address_set can insert or merge address history, clear cached customer details on linked non-deleted jobs and invoices, and mark this customer and descendants as edited.
  • The final write updates street_address1, last_edited, and edited_uuid, invalidates the customer cache, logs the edit, and fires Customer_edit.

See it in Fieldmotion

CRM1

Open the legacy customer edit popup, change Street Address 1, and filter Network requests for Customer_setStreet1.

CRM2

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

Related endpoints