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 a phone’s display name
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_bodySet or clear the custom display name for a phone.
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 '{"display_name": "QA iPhone"}'
Path Parameters
| Parameter | Type | Description |
|---|---|---|
phone_id | string | The phone identifier |
Request Body
{
"display_name": "QA iPhone"
}
| Field | Type | Required | Description |
|---|---|---|---|
display_name | string | null | No | Custom display name, or null to clear it |
Response
Returns the full phone object with updated settings. See List Phones for the complete response schema.Examples
Clear the Display Name
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 '{"display_name": null}'
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={"display_name": "QA iPhone"}
)
phone = response.json()
print(f"Updated display name: {phone['display_name']}")
Notes
- Set
display_nametonullto use the phone’s default name. - The display name appears in List Phones.
⌘I