Update one of the form's merchant's locations (partial)

patch

https://api.preczn.com/v1/forms/{formId}/locations/{locationId}

Form-scoped equivalent of PATCH /v1/merchants/:merchantId/locations/:locationId. Provided fields replace, omitted fields are untouched. name, address, mcc and phone may not be set to null. bankingId is the one nullable field — a valid account id assigns (re-validated against the merchant's banking[]), null clears. primaryLocationId is NOT settable here; use PUT /v1/forms/:formId/primary-location. Any unrecognized field returns 400 rather than being silently ignored.

Path Params

formId

string

required

The boarding form id.

locationId

string

required

The location id.

Body Params

name

string

length ≤ 255

Human-readable name for the location. May not be cleared to null.

address

object

Physical address of the location. May not be cleared to null.

mcc

string

length ≤ 4

Merchant category code for this location. May not be cleared to null.

phone

string

length ≤ 14

Location phone in strict E164 format (+1XXXXXXXXXX). May not be cleared to null.

bankingId

string | null

Id of the merchant banking[] entry funding this location. Send null to clear the assignment.

connectionData

array of objects

Per-connection configuration. ID-ANCHORED REPLACEMENT: the array sent is the desired end state of the client-written entries. An entry with an id updates that entry, an entry without one is created, and any stored client-written entry whose id is absent from the array is DELETED. May not be cleared to null; send [] to remove all client-written entries. Entries for Preczn-managed processors (currently AdyenForPlatforms) cannot be supplied (HTTP 400) and are kept when omitted. They may appear in responses, so leave them out when sending the array back. Each connection adds its own fields at the root of its entry. Jack Henry requires five ACH limit fields on every location: debitSingleTransAmount, debitSingleDayCount, debitSingleDayAmount, debitPeriodCount, and debitPeriodAmount. Each is a whole number; amounts are in whole dollars, and the period is two weeks. See the Jack Henry connection guide at https://docs.preczn.com/docs/jack-henry.

connectionData

Responses

400

Validation failure, an unrecognized field, a null core field, a bankingId that does not match a bank account on this merchant, or the form has expired ({ expirationUrl }).

404

Form, merchant, or location not found.

200Location updated.