Document "keys" endpoint used for BLE keys and alike (#703)

timdorr · Apr 5, 2023 · 9108149 · 9108149
1 parent 8e81eb5
commit 9108149
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/docs/api-basics/users.md b/docs/api-basics/users.md
@@ -48,3 +48,26 @@ Get the feature configuration for the mobile app.
   }
 }
 ```
+
+## POST `/api/1/users/keys`
+
+Update the name of a (bluetooth) key in all vehicles linked to the account. Refreshed inside the vehicle everytime the "Locks" menu is opened.
+
+`kind` and `public_key` must be set, everything else only needs to be set if you want to change it.
+
+### Parameters
+
+| Parameter  | Example       | Description                                                                                                     |
+| :--------- | :------------ | :-------------------------------------------------------------------------------------------------------------- |
+| kind       | mobile_device | Must be "mobile_device"                                                                                         |
+| public_key | 04ed05567b... | The ANSI X9.62/X9.63 representation of the public key that you wish to change (65 bytes long) - as a hex string |
+| name       | Sam's Phone   | The name of the key (main text)                                                                                 |
+| model      | iPhone 14 Pro | The model of the key (sub text)                                                                                 |
+
+### Response
+
+```json
+{
+  "response": true
+}
+```