Skip to content

Update device key

Request

Updates the metadata of a device key, such as the friendly device name or other custom data.

Required permissions: apps:edit, [appId]:edit, devices:edit.

Security
ClientAccessToken
Path
user_idstringrequired

ID of the user

key_idstringrequired

An identifier for the user's device

Bodyapplication/jsonrequired
display_namestring

Friendly device name, used when displaying a list of the user's devices

custom_dataobject

Custom data stored for this device, such as tags or device data obtained using other tools

push_configobject

Device push notification configuration

device_idstring

ID of the device to associate with this key

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/device-keys/{key_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "custom_data": {},
    "push_config": {
      "device_token": "stringstringstringstringstringst",
      "type": "FCM",
      "bundle_id": "string"
    },
    "device_id": "string"
  }'

Responses

Device key updated