Skip to main content
PATCH
/
v1
/
phones
/
{phone_id}
/
settings
Update Settings
curl --request PATCH \
  --url https://api.example.com/v1/phones/{phone_id}/settings

Documentation Index

Fetch the complete documentation index at: https://docs.tapkit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Update 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

ParameterTypeDescription
phone_idstringThe phone identifier

​
Request Body

{
  "typing_method": "shortcut",
  "speed": 90
}
FieldTypeRequiredDescription
typing_methodstringNoTyping method: "keys", "paste", "shortcut", or "shortcut_legacy"
speednumberNoSwitch control scanning speed: 30 (slow) or 90 (fast)
display_namestringNoCustom 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