Delete property by key¶

DELETE/devices/{id}/properties/{propertyKey}

Delete single device property by key.

Parameters¶

Name	In	Type	Required	Description
`id`	path	string (uuid)	Yes	Unique object identifier.
`propertyKey`	path	string	Yes	Device property key. Must be at most 100 characters long.
`X-Tenant-ID`	header	string (uuid)	Yes	Tenant ID.

Request samples¶

cURLPythonPowerShellGoJavaScript

curl -X DELETE "https://api-<data-region>.central.sophos.com/mobile/v1/devices/<id>/properties/<propertyKey>" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"

import requests

response = requests.delete(
    "https://api-<data-region>.central.sophos.com/mobile/v1/devices/<id>/properties/<propertyKey>",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
    },
)
print(response.json())

$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
}
Invoke-RestMethod -Method DELETE -Uri "https://api-<data-region>.central.sophos.com/mobile/v1/devices/<id>/properties/<propertyKey>" -Headers $headers

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, err := http.NewRequest("DELETE", "https://api-<data-region>.central.sophos.com/mobile/v1/devices/<id>/properties/<propertyKey>", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

const response = await fetch("https://api-<data-region>.central.sophos.com/mobile/v1/devices/<id>/properties/<propertyKey>", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses¶

`200` — Successfully processed Delete operation.¶

Response fields

deletedbooleanrequired

Errors¶

Status	Meaning
`400`	Invalid request.
`401`	Unauthorized.
`403`	Forbidden.
`409`	Conflicting modification.
`429`	Too many requests. See Retry-After header.
`500`	Internal server error.

All error responses share the same shape — see the error response object.

Response examples¶

`200`¶

{
  "deleted": true
}

See the guide for a narrative walkthrough of this API.