cURL
curl --request PATCH \
--url https://app.stockshift.io/api/v1/devices/{device} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Dock phone",
"location_id": "0199a0d0-0000-7000-8000-0000000000b1",
"work_center_id": "0199a0d0-0000-7000-8000-0000000000c1",
"offline_grace_hours": 24
}
'import requests
url = "https://app.stockshift.io/api/v1/devices/{device}"
payload = {
"name": "Dock phone",
"location_id": "0199a0d0-0000-7000-8000-0000000000b1",
"work_center_id": "0199a0d0-0000-7000-8000-0000000000c1",
"offline_grace_hours": 24
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/devices/{device}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Dock phone',
'location_id' => '0199a0d0-0000-7000-8000-0000000000b1',
'work_center_id' => '0199a0d0-0000-7000-8000-0000000000c1',
'offline_grace_hours' => 24
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/devices/{device}"
payload := strings.NewReader("{\n \"name\": \"Dock phone\",\n \"location_id\": \"0199a0d0-0000-7000-8000-0000000000b1\",\n \"work_center_id\": \"0199a0d0-0000-7000-8000-0000000000c1\",\n \"offline_grace_hours\": 24\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "0199a0d0-0000-7000-8000-000000000001",
"kind": "personal",
"platform": "ios",
"name": "Dock phone",
"model": "iPhone 16",
"os_version": "19.0",
"app_version": "1.4.2",
"app_build": 311,
"key_thumbprint": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
"status": "active",
"location_id": "<string>",
"work_center_id": "<string>",
"registered_by": 7,
"offline_grace_hours": 24,
"last_seen_at": "2026-10-13T09:00:00+00:00",
"last_sync_at": "<string>",
"wiped_at": "<string>",
"created_at": "2026-10-12T14:32:00+00:00",
"attestation": {
"provider": "<string>",
"verdict": "<string>",
"recorded_at": "<string>"
}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Devices
Rename a device, or set where it works
Send name alone to rename it: the member a personal device belongs to
may, and everyone else needs devices.manage. Send location_id,
work_center_id or both to set where it works, which needs
devices.manage; null clears a place and leaving it out keeps it. Needs
a token with devices:write. Audited. Repeating an Idempotency-Key
returns the first answer.
PATCH
/
devices
/
{device}
cURL
curl --request PATCH \
--url https://app.stockshift.io/api/v1/devices/{device} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Dock phone",
"location_id": "0199a0d0-0000-7000-8000-0000000000b1",
"work_center_id": "0199a0d0-0000-7000-8000-0000000000c1",
"offline_grace_hours": 24
}
'import requests
url = "https://app.stockshift.io/api/v1/devices/{device}"
payload = {
"name": "Dock phone",
"location_id": "0199a0d0-0000-7000-8000-0000000000b1",
"work_center_id": "0199a0d0-0000-7000-8000-0000000000c1",
"offline_grace_hours": 24
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/devices/{device}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Dock phone',
'location_id' => '0199a0d0-0000-7000-8000-0000000000b1',
'work_center_id' => '0199a0d0-0000-7000-8000-0000000000c1',
'offline_grace_hours' => 24
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/devices/{device}"
payload := strings.NewReader("{\n \"name\": \"Dock phone\",\n \"location_id\": \"0199a0d0-0000-7000-8000-0000000000b1\",\n \"work_center_id\": \"0199a0d0-0000-7000-8000-0000000000c1\",\n \"offline_grace_hours\": 24\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "0199a0d0-0000-7000-8000-000000000001",
"kind": "personal",
"platform": "ios",
"name": "Dock phone",
"model": "iPhone 16",
"os_version": "19.0",
"app_version": "1.4.2",
"app_build": 311,
"key_thumbprint": "NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs",
"status": "active",
"location_id": "<string>",
"work_center_id": "<string>",
"registered_by": 7,
"offline_grace_hours": 24,
"last_seen_at": "2026-10-13T09:00:00+00:00",
"last_sync_at": "<string>",
"wiped_at": "<string>",
"created_at": "2026-10-12T14:32:00+00:00",
"attestation": {
"provider": "<string>",
"verdict": "<string>",
"recorded_at": "<string>"
}
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Authorizations
apiKeyoauth2
For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.
Path Parameters
Body
application/json
Renames a device, or sets where it works and how long it may stay offline. One request does one of the two, because they ask for different permissions.
A new name, at most 80 characters. Send it alone.
Maximum string length:
80Example:
"Dock phone"
The location the device works at; null clears it. Leave it out to keep it.
Example:
"0199a0d0-0000-7000-8000-0000000000b1"
The work center the device works at; null clears it. Leave it out to keep it.
Example:
"0199a0d0-0000-7000-8000-0000000000c1"
Hours this device may stay offline before it locks itself, from 8 to 720; null follows the organization's setting. Leave it out to keep it.
Required range:
8 <= x <= 720Example:
24
Response
DeviceResource
Show child attributes
Show child attributes
Was this page helpful?