Upsert Device
Behaviour
This API is designed to upsert (create or update) a user device within Cortex.
You can update any field from the "Create Device" API except for the deviceId and authId.
Any tags or associatedIds included in this request are merged with existing tags, overwriting any existing tags with the same name.
Tags which have been added by a backend system cannot be modified via this endpoint.
Note: this endpoint can be used without having to first call the "Create Device" endpoint. If the deviceId doesn't currently exist on the server then a new device will be created automatically. Similar to the "Create Device" endpoint, if an access token is included as a header in the request then the authId will be extracted automatically.
Authentication
Authentication is required for this API using an API Key. This API key will be provided by the Cortex support team.
| Header | What’s it for | Example Value |
|---|---|---|
| X-APP-ID | Defines the application the call is accessing from, e.g. android, ios, or web. | android |
| X-REALM | Defines the space or client the caller is trying to access, e.g. CORTEX. | cortex |
| X-API-KEY | Defines the key or password the caller is authenticating with. These will be stored per app ID and realm. | super-secure-key-123 |