Locations

Update a location

Only values provided in the request will be updated.

patch/v2/locations/{id}

Request

Headers

x-customer-api-keystring

Request body

namestring

Must not be greater than 100 characters.

countrystring

The <code>iso</code> of an existing record in the countries table. Must be 2 characters.

citystring nullable

Must not be greater than 100 characters.

addressstring nullable

Must not be greater than 255 characters.

zip_codestring nullable

Must not be greater than 20 characters.

phone_numberstring nullable

Must not be greater than 40 characters.

emailstring nullable

Must be a valid email address. Must not be greater than 100 characters.

managerstring nullable

Must not be greater than 255 characters.

additional_informationstring nullable

Must not be greater than 1024 characters.

Example request

{
  "name": "xsw",
  "country": "ri",
  "city": "fkvyexjhhenjgyxsfhy",
  "address": "cndqkxrmxtzntfi",
  "zip_code": "pmczqek",
  "phone_number": "jjofnzimjvjdmni",
  "email": "collins.joesph@example.com",
  "manager": "pqbscnlbozwmfvhquiwfkly",
  "additional_information": "ktwxipkm"
}

Response

Success

Example response

{
  "data": {
    "id": 26440,
    "account_id": 19120,
    "name": "Downtown Bakery",
    "country": "US",
    "address": "176 Berry St, Brooklyn",
    "phone_number": "11002929",
    "email": "john.doe@brandtrack.fm",
    "manager": "John Doe",
    "created_at": "2024-07-31T14:38:34+00:00",
    "timezone": "America/Los_Angeles",
    "type": "own",
    "city": "New York",
    "zip_code": "11249",
    "additional_information": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.