Update Settings
curl --request PATCH \
--url https://api.example.com/v1/phones/{phone_id}/settingsimport requests
url = "https://api.example.com/v1/phones/{phone_id}/settings"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/v1/phones/{phone_id}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/phones/{phone_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/phones/{phone_id}/settings"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/phones/{phone_id}/settings")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/phones/{phone_id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyDevices
Update Settings
Update phone settings
PATCH
/
v1
/
phones
/
{phone_id}
/
settings
Update Settings
curl --request PATCH \
--url https://api.example.com/v1/phones/{phone_id}/settingsimport requests
url = "https://api.example.com/v1/phones/{phone_id}/settings"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/v1/phones/{phone_id}/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/phones/{phone_id}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/phones/{phone_id}/settings"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/phones/{phone_id}/settings")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/phones/{phone_id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyUpdate settings for a phone. Supports partial updates - only include the fields you want to change.
Request
curl -X PATCH https://api.tapkit.ai/v1/phones/{phone_id}/settings \
-H "X-API-Key: joot_your_api_key" \
-H "Content-Type: application/json" \
-d '{"typing_method": "shortcut", "speed": 90}'
Path Parameters
| Parameter | Type | Description |
|---|---|---|
phone_id | string | The phone identifier |
Request Body
{
"typing_method": "shortcut",
"speed": 90
}
| Field | Type | Required | Description |
|---|---|---|---|
typing_method | string | No | Typing method: "keys", "paste", "shortcut", or "shortcut_legacy" |
speed | number | No | Switch control scanning speed: 30 (slow) or 90 (fast) |
display_name | string | No | Custom display name for the phone |
Response
Returns the full phone object with updated settings. See List Phones for the complete response schema.Examples
Update Typing Method Only
curl -X PATCH https://api.tapkit.ai/v1/phones/{phone_id}/settings \
-H "X-API-Key: joot_your_api_key" \
-H "Content-Type: application/json" \
-d '{"typing_method": "shortcut"}'
Update Speed Only
curl -X PATCH https://api.tapkit.ai/v1/phones/{phone_id}/settings \
-H "X-API-Key: joot_your_api_key" \
-H "Content-Type: application/json" \
-d '{"speed": 30}'
Python
import requests
response = requests.patch(
"https://api.tapkit.ai/v1/phones/{phone_id}/settings",
headers={
"X-API-Key": "joot_...",
"Content-Type": "application/json"
},
json={"typing_method": "shortcut", "speed": 90}
)
phone = response.json()
print(f"Updated settings: {phone['typing_method']}, speed {phone['speed']}")
SDK
from tapkit import TapKitClient
client = TapKitClient(api_key="joot_...")
phone = client.get_phone("phone_id")
# Update just typing method
phone.update_settings(typing_method="shortcut")
# Update just speed
phone.update_settings(speed=90)
# Update both
phone.update_settings(typing_method="shortcut", speed=90)
Notes
- Partial updates are supported - omit fields you don’t want to change
- See Phone Settings for detailed explanations of each setting
- See Typing for information about typing methods
⌘I