Set or clear the form's merchant's primary location

Form-scoped equivalent of the primaryLocationId field on PATCH /v1/merchants/:merchantId. { "primaryLocationId": "<id>" } designates a location of the form's merchant as primary (404 if the id is not one of its locations); { "primaryLocationId": null } clears the designation. The key must be present — an empty body is a 400, not a clear.

Path Params
string
required

The boarding form id.

Body Params
string | null
required

Id of the location to designate as the merchant's primary, or null to clear the designation. Must belong to the form's merchant.

Responses

400

Validation failure, or the form has expired ({ expirationUrl }).

404

Form, merchant, or location not found.

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