• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update location BETA

PUT /v2/locations/{location_id}

Updates a location.


Permissions
MERCHANT_PROFILE_WRITE
Try in API Explorer
Name Description
location_id
string

Required

The ID of the location to update.

Name Description
location
Location

The Location object with only the fields to update.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

location
Location

The updated Location.

Examples

You are viewing an old version of the API
PUT /v2/locations/{location_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/locations/LOCATION_ID \
  -X PUT \
  -H 'Square-Version: 2020-09-23' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "location": {
      "name": "Updated nickname",
      "description": "Updated description",
      "facebook_url": null,
      "twitter_username": "twitter",
      "instagram_username": "instagram",
      "address": {
        "address_line_1": "1234 Peachtree St. NE",
        "administrative_district_level_1": "GA",
        "locality": "Atlanta",
        "postal_code": "30309"
      },
      "business_hours": {
        "periods": [
          {
            "day_of_week": "MON",
            "start_local_time": "09:00",
            "end_local_time": "17:00"
          }
        ]
      }
    }
  }'
Response JSON
{
  "location": {
    "id": "LOCATION_ID",
    "name": "Updated nickname",
    "address": {
      "address_line_1": "1234 Peachtree St. NE",
      "locality": "Atlanta",
      "administrative_district_level_1": "GA",
      "postal_code": "30309"
    },
    "timezone": "America/New_York",
    "capabilities": [
      "CREDIT_CARD_PROCESSING"
    ],
    "status": "ACTIVE",
    "created_at": "2019-07-19T17:58:25Z",
    "merchant_id": "MERCHANT_ID",
    "country": "US",
    "language_code": "en-US",
    "currency": "USD",
    "phone_number": "5559211234",
    "business_name": "Business Name",
    "type": "MOBILE",
    "website_url": "examplewebsite.com",
    "business_hours": {
      "periods": [
        {
          "day_of_week": "MON",
          "start_local_time": "09:00",
          "end_local_time": "17:00"
        }
      ]
    },
    "business_email": "example@squareup.com",
    "description": "Updated description",
    "twitter_username": "twitter",
    "instagram_username": "instagram",
    "coordinates": {
      "latitude": 33.788567,
      "longitude": -84.466947
    },
    "mcc": "1234"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?