Update a location (partial)

Partial update of a single location row — NOT a full-array replace. An omitted field keeps its stored value; a provided field replaces it. The core embedded fields (name, address and its sub-fields, mcc, phone) may not be set to null: a location's site facts are always concrete, so there is no "clear back to inherited" and a null is rejected with HTTP 400. bankingId is the one nullable field — send a valid account id to assign (re-validated against the merchant's banking[] exactly as create does), or null to clear the assignment. primaryLocationId is NOT settable here; it lives on the merchant PATCH, and sending it — or any other unrecognized field — returns 400 rather than being silently ignored.

Path Params
string
required
string
required
Body Params
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.

string
length ≤ 4

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

string
length ≤ 14

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

string | null

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

Responses

401

Unauthorized (test-mode mismatch).

403

Forbidden (platform mismatch).

404

Merchant not found, or location not found on this merchant.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json