Skip to main content

TeamViewer Component

Connect to TeamViewer to automate your remote support tasks.

Component key: teamviewer

Changelog ↓

Description​

TeamViewer is support software that allows users to connect to and control devices remotely for troubleshooting, collaboration, and management purposes.

Use the component to manage your devices, groups, contacts, patches, and more.

API Documentation​

The TeamViewer component was built using the TeamViewer WEB API

Connections​

OAuth 2.0​

To Create an OAuth app in Teamviewer:

  1. Login to your TeamViewer account.
  2. In the top right corner select your user icon and select Edit profile.
  3. Navigate to Apps and Select Create App.
  4. In the Redirect URL field enter https://oauth2.prismatic.io/callback.
  5. Ensure the app has sufficient permissions for an integration and select Create upon completion.
  6. Save and copy the Client ID and Client Secret and enter them into the connection configuration of your integration.
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for TeamViewer

https://login.teamviewer.com/oauth2/authorize?display=popup
Client ID

Client ID for the TeamViewer OAuth 2.0 connection

Client Secret

Client Secret for the TeamViewer OAuth 2.0 connection

Scopes

TeamViewer Scopes.

Token URL

The OAuth 2.0 Token URL for TeamViewer

https://webapi.teamviewer.com/api/v1/oauth2/token

Data Sources​

Select Contact​

Select a contact from a dropdown menu. | key: selectContact | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select Device​

Select a device from a dropdown menu. | key: selectDevice | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select Group​

Select a group from a dropdown menu. | key: selectGroup | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select Managed Device​

Select a managed device from a dropdown menu. | key: selectManagedDevice | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select Policy​

Select a TeamViewer policy from a dropdown menu. | key: selectPolicy | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select User​

Select a user from a dropdown menu. | key: selectUser | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Select User Role​

Select a user role from a dropdown menu. | key: selectUserRole | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "string",
      "key": "string"
    }
  ]
}

Actions​

Assign Device​

Assigns a device to a user account. | key: assignDevice

InputNotesExample
Assign Mode

The assign mode for the device.

auto
Connection
Current Password

The current password of the device.

password
Device ID

The ID of the device to retrieve.

123456
Enable Easy Access

Whether to enable easy access for the device.

false

{
  "data": {
    "remotecontrol_id": "string",
    "device_id": "string",
    "userid": "string",
    "alias": "string",
    "groupid": "string",
    "description": "string",
    "online_state": 0,
    "policy_id": "string",
    "assigned_to": true,
    "supported_features": "string",
    "last_seen": "2024-12-03T20:50:49.084Z",
    "teamviewer_id": 0
  }
}

Create Account​

Creates a new account. | key: createAccount

InputNotesExample
Client ID

The client ID associated with your TeamViewer account.

123456
Client Secret

The client secret associated with your TeamViewer account.

yourclientsecret
Connection
Email

The email address associated with your TeamViewer account.

test@test.com
Language

The language of the account holder.

en
Name

The name of the account holder.

John Doe
Password

The password associated with your TeamViewer account.

password

{
  "data": {
    "userid": "string",
    "email": "string",
    "name": "string",
    "company_name": "string",
    "company_id": "string",
    "permissions": "string",
    "profilepicture_url": "string",
    "license": {
      "license_type": 0,
      "version": 0,
      "type": "string",
      "details": "string",
      "teamViewerLicenseId": "00000000-0000-0000-0000-000000000000",
      "isactive": true
    },
    "email_validated": true,
    "email_language": "string",
    "available_licenses": [
      {
        "license_type": 0,
        "type": "string",
        "details": "string",
        "teamViewerLicenseId": "00000000-0000-0000-0000-000000000000",
        "isactive": true
      }
    ],
    "custom_field_has_paid_license": "string",
    "social_login_identity_issuer": "string"
  }
}

Create Contact​

Creates a new contact. | key: createContact

InputNotesExample
Connection
Description

The description of the contact.

This is my contact.
Email

The email of the contact.

test@test.com
Group ID

The ID of the group to which the contact belongs. Either groupid or groupName is required.

g3370655
Group Name

The name of the group to which the contact belongs. Either groupid or groupName is required.

My Group
Invite

Whether to invite the contact to TeamViewer.

false
Name

The name of the contact.

John Doe

{
  "data": {
    "contact_id": "string",
    "user_id": "string",
    "name": "string",
    "groupid": "string",
    "description": "string",
    "online_state": 0,
    "email": "string",
    "profilepicture_url": "string",
    "supported_features": "string"
  }
}

Create Device​

Creates a new device. | key: createDevice

InputNotesExample
Alias

The alias of the device.

My Device
Connection
Description

The description of the device.

This is my device.
Group ID

The ID of the group to which the device belongs.

g3370655
Password

The password of the device.

password
Remote Control ID

The ID of the remote control to assign to the device.

123456

{
  "data": {
    "remotecontrol_id": "string",
    "device_id": "string",
    "userid": "string",
    "alias": "string",
    "groupid": "string",
    "description": "string",
    "online_state": 0,
    "policy_id": "string",
    "assigned_to": true,
    "supported_features": "string",
    "last_seen": "2024-12-03T20:50:49.084Z",
    "teamviewer_id": 0
  }
}

Create Group​

Creates a new group. | key: createGroup

InputNotesExample
Connection
Name

The name of the group.

My Group
Policy ID

The policy ID of the group.

123456

{
  "data": {
    "id": "string",
    "name": "string",
    "shared_with": [
      {
        "userid": "string",
        "name": "string",
        "alias": "string",
        "permissions": "string",
        "pending": true
      }
    ],
    "owner": {
      "userid": "string",
      "name": "string",
      "alias": "string"
    },
    "permissions": "string",
    "policy_id": "string"
  }
}

Create Session​

Creates a new session. | key: createSession

InputNotesExample
Connection
Body

Custom fields to include in the request body.

Custom ID

The custom ID of the session.

123456
Description

The description of the session.

This is my session.
Group ID

The ID of the group to which the session belongs. Either groupid or groupName is required.

g337065
Group Name

The name of the group to which the session belongs. Either groupid or groupName is required.

My Group

{
  "data": {
    "code": "string",
    "state": "string",
    "groupid": "string",
    "custom_module_id": "string",
    "waiting_message": "string",
    "description": "string",
    "end_customer": {
      "name": "string",
      "email": "string"
    },
    "assigned_userid": "string",
    "assigned_at": "2024-12-03T22:25:44.414Z",
    "end_customer_link": "string",
    "supporter_link": "string",
    "webclient_supporter_link": "string",
    "custom_api": "string",
    "created_at": "2024-12-03T22:25:44.414Z",
    "valid_until": "2024-12-03T22:25:44.414Z",
    "closed_at": "2024-12-03T22:25:44.414Z",
    "tv_version": "string",
    "online": true,
    "support_session_type": "string"
  }
}

Create User​

Creates a user. | key: createUser

InputNotesExample
Connection
Custom Quick Join ID

Custom Quick Join ID of the user

<your_custom_quick_join_id>
Custom Quick Support ID

Custom Quick Support ID of the user

<your_custom_quick_support_id>
User Email

User email to query from.

example@company.io
Ignored Predefined Roles

Ignored Predefined Roles

false
User Language

User language.

en
License Key

License key of the user

<your_license_key>
Log Sessions

Should log user sessions.

false
Meeting License Key

Meeting License key of the user

<your_meeting_license_key>
User Name

User name to query from.

example_user
User Password

User password.

Show Comment Window

Should show comment window.

false
SSO Customer ID

SSO Customer ID of the user

<your_sso_customer_id>
Subscribe Newsletter

Should subscribe to the newsletter.

false
User Role ID

The ID of the user role to assign to the user.

<your-user-role-id>

{
  "data": {
    "id": "string",
    "name": "string",
    "online_state": "string",
    "permissions": "string",
    "active": true,
    "log_sessions": true,
    "show_comment_window": true,
    "custom_quicksupport_id": "string",
    "custom_quickjoin_id": "string",
    "email": "string",
    "last_access_date": "2024-12-17T14:25:39.312Z",
    "activated_license_id": "00000000-0000-0000-0000-000000000000",
    "activated_license_name": "string",
    "activated_subLicense_name": "string",
    "activated_meeting_license_key": "00000000-0000-0000-0000-000000000000",
    "userRoleId": "00000000-0000-0000-0000-000000000000"
  }
}

Delete Contact​

Deletes a contact by its ID. | key: deleteContact

InputNotesExample
Connection
Contacts ID

The ID of the contact to delete.

123456

{
  "data": "ACTION SUCCEEDED"
}

Delete Device​

Deletes a device by its ID. | key: deleteDevice

InputNotesExample
Connection
Device ID

The ID of the device to delete.

123456

{
  "data": "ACTION SUCCEEDED"
}

Delete Group​

Deletes a group by its ID. | key: deleteGroup

InputNotesExample
Connection
Group ID

The ID of the group to delete.

123456

{
  "data": "ACTION SUCCEEDED"
}

Delete Managed Device​

Deletes a managed device by its ID. | key: deleteManagedDevice

InputNotesExample
Connection
Managed Device ID

The ID of the managed device to delete.

123456

{
  "data": "ACTION SUCCEEDED"
}

Delete User​

Deletes a user. | key: deleteUser

InputNotesExample
Connection
Permanent Delete

Whether to permanently delete the user or just deactivate them.

false
User ID

The ID of the user to retrieve.

<your-user-id>

{
  "data": "ACTION SUCCEEDED"
}

Delete User Company​

Deletes the company of account (user) that is associated with the used API token. This account should be the last user with admin rights at the company. | key: deleteUserCompany

InputNotesExample
Connection

{
  "data": "ACTION SUCCEEDED"
}

Get Account​

Returns the account that is associated with the used API token. | key: getAccount

InputNotesExample
Connection

{
  "data": {
    "userid": "string",
    "email": "string",
    "name": "string",
    "company_name": "string",
    "company_id": "string",
    "permissions": "string",
    "profilepicture_url": "string",
    "license": {
      "license_type": 0,
      "version": 0,
      "type": "string",
      "details": "string",
      "teamViewerLicenseId": "00000000-0000-0000-0000-000000000000",
      "isactive": true
    },
    "email_validated": true,
    "email_language": "string",
    "available_licenses": [
      {
        "license_type": 0,
        "type": "string",
        "details": "string",
        "teamViewerLicenseId": "00000000-0000-0000-0000-000000000000",
        "isactive": true
      }
    ],
    "custom_field_has_paid_license": "string",
    "social_login_identity_issuer": "string"
  }
}

Get Account Tenant IDs​

Returns the account's tenant IDs. | key: getAccountTenantIds

InputNotesExample
Connection

{
  "data": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Get Contact​

Returns a contact by its ID. | key: getContact

InputNotesExample
Connection
Contacts ID

The ID of the contact to retrieve.

123456

{
  "data": {
    "contact_id": "string",
    "user_id": "string",
    "name": "string",
    "groupid": "string",
    "description": "string",
    "online_state": 0,
    "email": "string",
    "profilepicture_url": "string",
    "supported_features": "string"
  }
}

Get Device​

Returns a device by its ID. | key: getDevice

InputNotesExample
Connection
Device ID

The ID of the device to retrieve.

123456

{
  "data": {
    "devices": [
      {
        "remotecontrol_id": "string",
        "device_id": "string",
        "userid": "string",
        "alias": "string",
        "groupid": "string",
        "description": "string",
        "online_state": 0,
        "policy_id": "string",
        "assigned_to": true,
        "supported_features": "string",
        "last_seen": "2024-12-03T20:50:49.084Z",
        "teamviewer_id": 0
      }
    ]
  }
}

Get Group​

Returns a group by its ID. | key: getGroup

InputNotesExample
Connection
Group ID

The ID of the group to retrieve.

123456

{
  "data": {
    "id": "string",
    "name": "string",
    "shared_with": [
      {
        "userid": "string",
        "name": "string",
        "alias": "string",
        "permissions": "string",
        "pending": true
      }
    ],
    "owner": {
      "userid": "string",
      "name": "string",
      "alias": "string"
    },
    "permissions": "string",
    "policy_id": "string"
  }
}

Get Managed Device​

Returns a managed device by its ID. | key: getManagedDevice

InputNotesExample
Connection
Managed Device ID

The ID of the managed device to retrieve.

123456

{
  "data": {
    "teamviewerPolicyId": "00000000-0000-0000-0000-000000000000",
    "teamViewerVersion": "string",
    "deviceDescription": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "teamviewerId": 0,
    "name": "string",
    "isOnline": true,
    "last_seen": "2024-12-04T22:46:21.549Z"
  }
}

Get Missing Patches​

This request will return all missing patches on the device, which id is provided in the request. | key: getMissingPatches

InputNotesExample
Connection
Device ID

The ID of the device to retrieve missing patches for.

123456

{
  "data": {
    "device_id": 0,
    "patches": [
      {
        "patch_id": "00000000-0000-0000-0000-000000000000",
        "patch_region_id": 0,
        "severity": 0,
        "product_name": "string",
        "bulletin_name": "string",
        "bulletin_url": "string",
        "bulletin_title": "string",
        "download_url": "string",
        "type": 0,
        "kb": "string",
        "cve": [
          "string"
        ],
        "release_date": {
          "_underlyingValue": "2024-12-04T23:48:08.237Z"
        },
        "patch_size": 0,
        "patch_details": "string",
        "installable": true,
        "is_service_pack": true
      }
    ]
  }
}

Get Ping​

Returns if the current token is valid. | key: getPing

InputNotesExample
Connection

{
  "data": {
    "token_valid": false
  }
}

Get Session​

Returns a session by its ID. | key: getSession

InputNotesExample
Connection
Session ID

The ID of the session to retrieve.

123456

{
  "data": {
    "code": "string",
    "state": "string",
    "groupid": "string",
    "custom_module_id": "string",
    "waiting_message": "string",
    "description": "string",
    "end_customer": {
      "name": "string",
      "email": "string"
    },
    "assigned_userid": "string",
    "assigned_at": "2024-12-03T22:25:44.414Z",
    "end_customer_link": "string",
    "supporter_link": "string",
    "webclient_supporter_link": "string",
    "custom_api": "string",
    "created_at": "2024-12-03T22:25:44.414Z",
    "valid_until": "2024-12-03T22:25:44.414Z",
    "closed_at": "2024-12-03T22:25:44.414Z",
    "tv_version": "string",
    "online": true,
    "support_session_type": "string"
  }
}

Get User​

Retrieves the user associated with the used API token. | key: getUser

InputNotesExample
Connection
User ID

The ID of the user to retrieve.

<your-user-id>

{
  "data": {
    "id": "string",
    "name": "string",
    "online_state": "string",
    "permissions": "string",
    "active": true,
    "log_sessions": true,
    "show_comment_window": true,
    "custom_quicksupport_id": "string",
    "custom_quickjoin_id": "string",
    "email": "string",
    "last_access_date": "2024-12-17T14:02:46.010Z",
    "activated_license_id": "00000000-0000-0000-0000-000000000000",
    "activated_license_name": "string",
    "activated_subLicense_name": "string",
    "activated_meeting_license_key": "00000000-0000-0000-0000-000000000000",
    "userRoleId": "00000000-0000-0000-0000-000000000000"
  }
}

List Company Managed Devices​

Lists one page of company-managed devices of the company that is associated with the currently logged-in session. | key: listCompanyManagedDevices

InputNotesExample
Connection
Fetch All

Whether to fetch all records or just the first page.

false
Pagination Token

To fetch the next batch of result items, provide the value received as 'nextPaginationToken' from the previous call. Will fetch the first page if not given.

paginationToken123
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "currentPaginationToken": "string",
    "nextPaginationToken": "string",
    "resources": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "teamviewerId": 0,
        "name": "string",
        "isOnline": true,
        "last_seen": "2024-12-04T22:46:21.547Z"
      }
    ]
  }
}

List Contacts​

Returns a list of contacts. | key: listContacts

InputNotesExample
Connection
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "contacts": [
      {
        "contact_id": "string",
        "user_id": "string",
        "name": "string",
        "groupid": "string",
        "description": "string",
        "online_state": 0,
        "email": "string",
        "profilepicture_url": "string",
        "supported_features": "string"
      }
    ],
    "invitations": [
      {
        "groupid": "string",
        "email": "string"
      }
    ]
  }
}

List Devices​

Returns a list of devices. | key: listDevices

InputNotesExample
Connection
Group ID

The ID of the group to which the device belongs.

g3370655
Name

The name of the device.

My Device
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2
Remote Control ID

The ID of the remote control to assign to the device.

123456

{
  "data": {
    "devices": [
      {
        "remotecontrol_id": "string",
        "device_id": "string",
        "userid": "string",
        "alias": "string",
        "groupid": "string",
        "description": "string",
        "online_state": 0,
        "policy_id": "string",
        "assigned_to": true,
        "supported_features": "string",
        "last_seen": "2024-12-03T20:50:49.084Z",
        "teamviewer_id": 0
      }
    ]
  }
}

List Groups​

Returns a list of groups. | key: listGroups

InputNotesExample
Connection
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "groups": [
      {
        "id": "string",
        "name": "string",
        "shared_with": [
          {
            "userid": "string",
            "name": "string",
            "alias": "string",
            "permissions": "string",
            "pending": true
          }
        ],
        "owner": {
          "userid": "string",
          "name": "string",
          "alias": "string"
        },
        "permissions": "string",
        "policy_id": "string"
      }
    ]
  }
}

List Managed Devices​

Returns a list of managed devices. | key: listManagedDevices

InputNotesExample
Connection
Fetch All

Whether to fetch all records or just the first page.

false
Pagination Token

To fetch the next batch of result items, provide the value received as 'nextPaginationToken' from the previous call. Will fetch the first page if not given.

paginationToken123
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "currentPaginationToken": "string",
    "nextPaginationToken": "string",
    "resources": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "teamviewerId": 0,
        "name": "string",
        "isOnline": true,
        "last_seen": "2024-12-04T21:42:48.222Z"
      }
    ]
  }
}

List Patch Management Device​

Returns a list of patch management devices. | key: listPatchMagementDevices

InputNotesExample
Connection
Continuation Token

The continuation token from the previous response.

123456
Fetch All

Whether to fetch all records or just the first page.

false
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "devices": [
      {
        "teamviewer_id": 0,
        "activation_time": {
          "_underlyingValue": "2024-12-04T23:27:05.237Z"
        }
      }
    ],
    "continuation_token": "string"
  }
}

List Sessions​

Returns a list of sessions. | key: listSessions

InputNotesExample
Connection
Query Parameters

The query parameters to include in the request.

key1=value1&key2=value2

{
  "data": {
    "sessions": [
      {
        "code": "string",
        "state": "string",
        "groupid": "string",
        "custom_module_id": "string",
        "waiting_message": "string",
        "description": "string",
        "end_customer": {
          "name": "string",
          "email": "string"
        },
        "assigned_userid": "string",
        "assigned_at": "2024-12-03T22:25:44.414Z",
        "end_customer_link": "string",
        "supporter_link": "string",
        "webclient_supporter_link": "string",
        "custom_api": "string",
        "created_at": "2024-12-03T22:25:44.414Z",
        "valid_until": "2024-12-03T22:25:44.414Z",
        "closed_at": "2024-12-03T22:25:44.414Z",
        "tv_version": "string",
        "online": true,
        "support_session_type": "string"
      }
    ],
    "next_offset": "string",
    "sessions_remaining": 0
  }
}

List Users​

Retrieves all users with given filter criteria. | key: listUsers

InputNotesExample
Connection
Full List

Is detailed user information needed

false
User Permissions

Comma separated access rights. Please use user role APIs for user's rights.

ADMIN, USER
User Email

User email to query from.

example@company.io
User Name

User name to query from.

example_user

{
  "data": {
    "users": [
      {
        "id": "string",
        "name": "string",
        "online_state": "string",
        "permissions": "string",
        "active": true,
        "log_sessions": true,
        "show_comment_window": true,
        "custom_quicksupport_id": "string",
        "custom_quickjoin_id": "string",
        "email": "string",
        "last_access_date": "2024-12-17T14:17:23.541Z",
        "activated_license_id": "00000000-0000-0000-0000-000000000000",
        "activated_license_name": "string",
        "activated_subLicense_name": "string",
        "activated_meeting_license_key": "00000000-0000-0000-0000-000000000000",
        "userRoleId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to Teamviewer API | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/contacts), The base URL is already included (https://webapi.teamviewer.com/api/v1/). For example, to connect to https://webapi.teamviewer.com/api/v1/contacts, only /contacts is entered in this field. e.g. /contacts

/contacts
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Scan Results Count​

Retrieves the number of scan results for the specified devices. | key: scanResultsCount

InputNotesExample
Connection
Continuation Token

The continuation token from the previous response.

123456
Device ID List

A list of device IDs to retrieve missing patches for.

{
  "data": {
    "DeviceMissingPatchesCountInfoList": [
      {
        "DeviceId": 0,
        "ErrorCode": 0,
        "ScanResultCount": 0
      }
    ],
    "ContinuationToken": "string"
  }
}

Update Account​

Updates an account. | key: updateAccount

InputNotesExample
Connection
Email

The email address associated with your TeamViewer account.

test@test.com
Email Language

The language of the account holder.

en
Name

The name of the account holder.

John Doe
Old Password

The current password associated with your TeamViewer account.

password
Password

The password associated with your TeamViewer account.

password

{
  "data": "ACTION SUCCEEDED"
}

Update Device​

Updates a device by its ID. | key: updateDevice

InputNotesExample
Alias

The alias of the device.

My Device
Connection
Description

The description of the device.

This is my device.
Device ID

The ID of the device to retrieve.

123456
Group ID

The ID of the group to which the device belongs.

g3370655
Password

The password of the device.

password
Remote Control ID

The ID of the remote control to assign to the device.

123456

{
  "data": "ACTION SUCCEEDED"
}

Update Group​

Updates an existing group by its ID. | key: updateGroup

InputNotesExample
Connection
Group ID

The ID of the group to update.

123456
Name

The name of the group.

My Group
Policy ID

The policy ID of the group.

123456

{
  "data": "ACTION SUCCEEDED"
}

Update Managed Device​

Modify the attributes of a managed device using its designated 'id.' You can provide the device's 'name' (alias) to enact changes, provide a 'teamviewerPolicyId' to update or add a TeamViewer policy, or provide a 'managedGroupId' to inherit the TeamViewer Policy from a managed group to which the device is associated. | key: updateManagedDevice

InputNotesExample
Connection
Managed Device ID

The ID of the managed device to retrieve.

123456
Managed Group ID

The ID of the managed group to associate with the managed device.

123456
Name

The name of the managed device.

My Device
TeamViewer Policy ID

The TeamViewer policy ID of the managed device.

123456

{
  "data": "ACTION SUCCEEDED"
}

Update Session​

Updates a session by its ID. | key: updateSession

InputNotesExample
Connection
Body

Custom fields to include in the request body.

Custom ID

The custom ID of the session.

123456
Description

The description of the session.

This is my session.
Group ID

The ID of the group to which the session belongs. Either groupid or groupName is required.

g337065
Group Name

The name of the group to which the session belongs. Either groupid or groupName is required.

My Group
Session ID

The ID of the session to retrieve.

123456

{
  "data": "ACTION SUCCEEDED"
}

Update User​

Updates a user. | key: updateUser

InputNotesExample
Is User Active

Deactivates or Activates the user account.

false
Assign User Role IDs

Comma separated list of user role IDs to assign to the user.

Connection
Custom Quick Join ID

Custom Quick Join ID of the user

<your_custom_quick_join_id>
Custom Quick Support ID

Custom Quick Support ID of the user

<your_custom_quick_support_id>
User Email

User email to query from.

example@company.io
License Key

License key of the user

<your_license_key>
Log Sessions

Should log user sessions.

false
User Name

User name to query from.

example_user
User Password

User password.

Show Comment Window

Should show comment window.

false
SSO Customer ID

SSO Customer ID of the user

<your_sso_customer_id>
Is TFA Enforced

Enforces Two Factor Authentication for the user.

false
Unassign User Role IDs

Comma separated list of user role IDs to unassign to the user.

User ID

The ID of the user to retrieve.

<your-user-id>

{
  "data": "ACTION SUCCEEDED"
}

Changelog​

2025-08-15​

  • Added new data sources and inline data sources for Contacts, Policies, Users, User Roles.