Update a location

patch

https://sandbox-api.prioritycommerce.com/v1/businesses/{businessId}/locations/{id}

Updates a location. Send only the fields you want to change. You can update a single address field without sending the whole address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

businessId

string

required

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

string

required

ID of the location, for example loc_8f1a3d62-5c9e-4b27-a8d4-3e7b1f6c2a94.

Body Params

Location fields to update. Send only the fields you want to change.

externalId

string

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

name

string

Name of the location as customers see it, for example the store name. Up to 200 characters.

isPrimary

boolean

Set to true for the main record of this kind.

address

object

Street address of the location.

phone

string

Phone number of the location in international E.164 format, for example +15125550187.

string

Main contact email address.

website

string

The website of the business, up to 512 characters.

processingProfile

object

How the location expects to take payments. Needed to activate card processing (payin.card).

operational

object

When the location is open for business. Needed to activate card processing (payin.card).

industry

object

The type of business carried out at the location. Needed to activate card processing (payin.card).

Responses

200Updated. The response contains the updated record.

401The API key is missing or invalid.

404No record exists with the ID in the path.

422The request failed validation. errors lists each field to fix.