How To: Location

3min

For more information about prerequisites, see the Integrate with Location service﻿.
How to: Create a Location
To create the location, call the Create a new location﻿ endpoint and specify the required attributes﻿ in the request body.
The request body is specified in JSON format. The following example of a request body shows how to create a Location.
JSON
{
    "tags": {
        "timezone": "UTC-5: Eastern Standard Time (EST)",
    },
    "address": {
        "buildingNumber": "123",
        "addressLine1": "Main Street",
        "addressLine2": "Anytown",
        "addressLine3": "Marylebone, NW1 6XE, UK",
        "city": "Queens",
        "state": "New York",
        "country": {
            "code": "+1",
            "name": "United States"
        },
        "zipCode": "11418"
    },
    "geolocation": {
        "lat": "40.674778",
        "long": "-73.800629"
    }
}

{
    "tags": {
        "timezone": "UTC-5: Eastern Standard Time (EST)",
    },
    "address": {
        "buildingNumber": "123",
        "addressLine1": "Main Street",
        "addressLine2": "Anytown",
        "addressLine3": "Marylebone, NW1 6XE, UK",
        "city": "Queens",
        "state": "New York",
        "country": {
            "code": "+1",
            "name": "United States"
        },
        "zipCode": "11418"
    },
    "geolocation": {
        "lat": "40.674778",
        "long": "-73.800629"
    }
}
﻿
How to: Update Location
For information about prerequisites, see Integrate with Location Service.
For information about creating location, see How to: Create Location.
To update the location, call the update an existing location﻿ endpoint and specify the required attributes in the request body.
📘 Note﻿
Partial update of address is not allowed. The user needs to replace the existing address
The request body is specified in JSON format. The following example of a request body shows how to Update Location.
JSON
{
    "tags": {
        "timezone": "UTC-8: Pacific Standard Time (PST)",
    },
    "address": {
        "buildingNumber": "58-E",
        "addressLine1": "4842 Horizon Circle",
        "addressLine3": "Marylebone, NW1 6XE, UK",
        "city": "Tacoma",
        "state": "Washington",
        "zipCode": "98402"
    },
    "geolocation": {
        "lat": "47.215637",
        "long": "-122.491043"
    }
}
{
    "tags": {
        "timezone": "UTC-8: Pacific Standard Time (PST)",
    },
    "address": {
        "buildingNumber": "58-E",
        "addressLine1": "4842 Horizon Circle",
        "addressLine3": "Marylebone, NW1 6XE, UK",
        "city": "Tacoma",
        "state": "Washington",
        "zipCode": "98402"
    },
    "geolocation": {
        "lat": "47.215637",
        "long": "-122.491043"
    }
}
﻿
How to: Get Location
To retrieve the location details by Location ID, call the Get location by location id﻿ endpoint.

Updated 16 Aug 2023

Did this page help you?

Integrate with Location Service

How to: Country

Docs powered by Archbee

TABLE OF CONTENTS

How to: Create a Location

How to: Update Location

How to: Get Location