Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
In-Person Locations

Update an in-person location

Updates an in-person location via its unique ID. Note that addresses and geo co-ordinates cannot be updated, to do this you must create a new location and delete the old one

patch/in-person/locations/{id}

Path parameters

idstring required
Example:iploc_01FCTS1XMKH9FF43CAFA4CXT3P

the unique ID of the location

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this when you want to update an in person location under a linked account)

Request body

namestring nullable

Your name for the location. This can be used for display purposes.

metadataobject nullable

Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 10 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.

Example request

{
  "name": "Front of main office",
  "metadata": {
    "internalID": "1"
  }
}

Response

The resource was retrieved successfully

idstring

The unique Id of the location

namestring

Your name for the location. This can be used for display purposes.

metadataobject

Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 10 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.

createdTimestampinteger

The epoch timestamp (seconds) when the object was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the object was last updated

Example response

{
  "id": "iploc_01FCTS1XMKH9FF43CAFA4CXT3P",
  "name": "Head Office front desk",
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": "456 Test Lane",
    "city": "Manchester",
    "country": "GB",
    "postalCode": "M3 3AG",
    "region": "Greater Manchester"
  },
  "geoCoordinates": {
    "latitude": 51.1789,
    "longitude": 1.8262
  },
  "metadata": {
    "internalID": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}