/api/v1/home-assistant/link-requests/{id}/approve

POST

/api/v1/home-assistant/link-requests/{id}/approve

curl --request POST \
  --url https://example.com/api/v1/home-assistant/link-requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approve \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "read", "locationIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "confirmCrossLocation": true }'

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

Media typeapplication/json

object

scope

required

string

Allowed values: read write

locationIds

required

Array<string>

>= 1 items <= 100 items

confirmCrossLocation

boolean

Responses

200

Default Response

Media typeapplication/json

object

warning

required

string

Allowed values: cross_location_write

Example

{
  "warning": "cross_location_write"
}

202

Default Response

Media typeapplication/json

object

state

required

string

Allowed values: approved

Example

{
  "state": "approved"
}