Skip to main content

How do I add an external ID to a location?

Overview

Every location can have an external id: the identifier that integrations with other systems use to recognise the location.

This article explains how to change it.

Change the external id of a location

Go to: Locations > [location] > Detail

  1. In the menu, go to Locations and click the location you want to change.

  2. Stay on the Detail tab.

  3. Under Address, click the External id field and type or change the value.

  4. Next to Details, click Save. To discard your change, click Cancel.

Location with the External id field under Address

⚠️ On the right, the service (for example Heat) has its own Ext id field. That is a different id and not the external id of the location. Change the field under Address instead. Every change to the external id is kept in the location's activity history.

Troubleshoot

Problem

Solution

I cannot change the external id.

You probably do not have permission to change a location's external id. Ask your environment administrator.

I no longer know the previous external id.

Open the location's activity history: it lists every change to the external id.

An integration no longer recognises the location.

Check that the external id matches the identifier in the other system exactly, including capitals and dashes.

FAQ

What do I use the external id for?
Integrations with other systems use the external id to recognise the location, so fill it in if your integration relies on it.

Can I change the external id later?
Yes, follow the steps above. The change is kept in the location's activity history.

Do I always have to fill in the external id?
No, only if an integration uses it.

Did this answer your question?