You are viewing an old version of the API
Update location

Beta

Updates a location

Required permissions MERCHANT_PROFILE_WRITE

Path Parameters

Name Description
location_id
string

Required

The ID of the location to update.

Request Body

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
curl https://connect.squareup.com/v2/locations/{location_id} \
  -X PUT \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -d '{
    "location": {
      "name": "Updated nickname",
      "description": "Updated description",
      "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": "Q3X50GJ7A21EW",
    "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?