Create

Grants access to the device for new user. This endpoint can be used by owner or administrator of the device.

Note

User can have only one active share to the device at the time.

POST https://api.tedee.com/api/v1.30/my/deviceshare

Body Parameters

Name	Type	Description
accessLevel	Access level	represents user access level
deviceId	number	device id
remoteAccessDisabled	boolean	represents if remote access is disabled
repeatEvent	Repeat event	represents repeat event of the share
userEmail	string	user email that device will be shared with

Responses

Name	Type	Description
201 Created	Device Share Success	successful operation

Scopes

Name	Description
DeviceShare.ReadWrite	Grants user possibility to read and write data connected with device shares

Examples

Grant permanent administrator access

Sample request

curl -X POST "https://api.tedee.com/api/v1.30/my/deviceshare" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "deviceId": 1,
    "accessLevel": 1,
    "userEmail": "[email protected]"
    "repeatEvent": {
        "weekDays": null,
        "dayStartTime": null,
        "dayEndTime": null,
        "startDate": null,
        "endDate": null
    },
    "remoteAccessDisabled" : false
}

Sample response

HTTP status code: 201

{
    "result": {
        "id": 1,
        "sharedUserDisplayName": "John Doe"
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 201
}

Grant guest time restricted access

Sample request

curl -X POST "https://api.tedee.com/api/v1.30/my/deviceshare" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "deviceId": 1,
    "accessLevel": 0,
    "userEmail": "[email protected]"
    "repeatEvent": {
        "weekDays": null,
        "dayStartTime": null,
        "dayEndTime": null,
        "startDate": "2020-12-14T08:09:57.781Z",
        "endDate": "2020-12-31T08:10:57.781Z"
    },
    "remoteAccessDisabled" : false
}

Sample response

HTTP status code: 201

{
    "result": {
        "id": 1,
        "sharedUserDisplayName": "John Doe"
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 201
}

Grant guest custom access

Sample request

curl -X POST "https://api.tedee.com/api/v1.30/my/deviceshare" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "deviceId": 1,
    "accessLevel": 0,
    "userEmail": "[email protected]"
    "repeatEvent": {
        "weekDays": 7,
        "dayStartTime": "2020-12-01T08:00:00.000Z",
        "dayEndTime": "2020-12-31T20:00:00.000Z",
        "startDate": "2020-12-01T08:09:57.781Z",
        "endDate": "2020-12-31T23:10:57.781Z"
    },
    "remoteAccessDisabled" : false
}

Sample response

HTTP status code: 201

{
    "result": {
        "id": 1,
        "sharedUserDisplayName": "John Doe"
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 201
}