Rename a device, or change its settings

PATCH

/v1/devices/{id}

curl --request PATCH \
  --url https://api.pocketbell.dev/v1/devices/dev_01jz9k6q8r3tfv0x2m4n5p7s8a \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "play_sounds": true, "quiet_hours": true }'

Authorizations

• session

Parameters

Path Parameters

id

required

string

Example

dev_01jz9k6q8r3tfv0x2m4n5p7s8a

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 100 characters

play_sounds

boolean

quiet_hours

boolean

Example^generated

{
  "name": "example",
  "play_sounds": true,
  "quiet_hours": true
}

Responses

204

Changed.

400

The request was invalid.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Which fields were wrong, for invalid_request.

Array<object>

object

field

required

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

401

Missing or ended session.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Which fields were wrong, for invalid_request.

Array<object>

object

field

required

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}

404

No such device on this account.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Which fields were wrong, for invalid_request.

Array<object>

object

field

required

string

message

required

string

Example

{
  "error": {
    "code": "invalid_request"
  }
}