Tedee API documentation

Overview

  • Getting started
  • API versioning
  • API rate limit
  • Logo guideliness
  • Release notes

How to ...

  • Begin integration
  • Authenticate
  • Get and sync locks
  • Operate locks
  • Update lock settings
  • Share device
  • Manage lock PIN list
  • Manage access links
  • Manage and operate gates
  • Use state from door sensor
  • Connect to device via Bluetooth
  • Example integrations

Endpoints

  • DateTime
  • Device
  • Device activity
  • Devices certificate
  • Device access
  • Door sensor
  • Gate
  • Lock
  • Lock PIN
  • Mobile
  • Organization
  • Organization Access Links
    • Get organization links
    • Get organization link
    • Get organization link url
    • Get access link assignable devices
    • Create organization link
    • Update organization link
      • Responses
      • Scopes
      • Examples
        • Update organization access link
    • Delete organization link
  • Personal access key

Webhooks

  • Overview
  • Device battery level changed
  • Device connection changed
  • Device settings changed
  • Lock status changed
  • Bell button pressed

Data structures

  • Access details
  • Bridge
  • Certificate for mobile
  • Device activities
  • Device access
  • Device operation
  • Device settings
  • Device access success
  • Device updated
  • Door sensor list
  • Door sensor state
  • Door sensor user settings
  • Door sensor
  • Execute command response
  • Gate list
  • Gate user settings
  • Gate
  • Location
  • Lock
  • Lock accessory
  • Lock PIN
  • Lock PIN created
  • Lock PIN details
  • Lock PIN list
  • Lock state
  • Lock sync
  • Lock user settings
  • Mobile identifier
  • Mobile registered
  • Organization
  • Organization access link
  • Organization access link created
  • Organization access link list
  • Organization access link single
  • Organization access link device
  • Organization access link assignable device list
  • Organization access link assignable device
  • Personal access key
  • Personal access key created
  • Repeat event
  • Revoked certificate
  • Revoked certificate list
  • Signed time
  • Software versions

Enums

  • Access level
  • Activity source
  • Auto unlock pull condition
  • Device operation type
  • Device type
  • Door state
  • Event type
  • Gate icon
  • Lock state
  • Operating System type
  • Software type
  • Unlock mode
  • Week days
Tedee API documentation
  • Organization Access Links
  • Update organization access link
  • View page source

Update organization access link

Updates an organization access link.

PATCH https://api.tedee.com/api/v1.36/organization/{organizationId}/accesslink/{accessLinkId}

Warning

We do not recommend to create access links with permanent access.

URI Parameters

Name

Type

Description

organizationId

number

id of the organization

accessLinkId

UUID

id of the access link

Body Parameters

Name

Type

Description

name

string (optional)

access link name (visible only during management)

description

string (optional, multiline)

access link description for guests

devicesIds

int [] (optional)

array of devices included in the access link

repeatEvent

Repeat event (optional)

repeat event of the access link

Note

Access links requirements:

  • description must be in range 0-72 characters

  • deviceIds must contain at least one device

  • deviceIds must contain distinct device ids

  • user must be at least organization admin to perform this operation

Note

Dates sent to Tedee API must be in the UTC timezone. The client must convert the date to UTC before sending it to the API.

Responses

Name

Type

Description

200 OK

successful operation

400 Bad Request

request model is not valid

404 Not found

organization does not exist or user is not allowed to manage it

Scopes

Name

Description

AccessLink.ReadWrite

Grants user possibility to manage organization access links

Examples

Update organization access link

Sample request for organization with id = 123

curl -X PATCH "https://api.tedee.com/api/v1.36/organization/123/accesslink/10df36b5-a06e-4bec-9398-786b0231453a" -H "accept: application/json" -H "Content-Type: application/json-patch+json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "repeatEvent": {
        "startDate": "2023-02-01T00:00:00.000Z",
        "endDate": "2023-03-01T00:00:00.000Z"
    }
}

Sample response

HTTP status code: 200

{
    "success": true,
    "errorMessages": [],
    "statusCode": 200
}
Previous Next

© Copyright 2023, Tedee.

Built with Sphinx using a theme provided by Read the Docs.