TeamViewer Component

Connect to TeamViewer to automate your remote support tasks.

Component key: teamviewer

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:

Login to your TeamViewer account.
In the top right corner select your user icon and select Edit profile.
Navigate to Apps and Select Create App.
In the Redirect URL field enter https://oauth2.prismatic.io/callback for US based integrations.
1. For integrations outside the US refer to this guide to find your region’s Callback URL.
Ensure the app has sufficient permissions for an integration and select Create upon completion.
Save and copy the Client ID and Client Secret and enter them into the connection configuration of your integration.

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://login.teamviewer.com/oauth2/authorize?display=popup	The OAuth 2.0 Authorization URL for TeamViewer
Client ID string / Required clientId		Client ID for the TeamViewer OAuth 2.0 connection
Client Secret password / Required clientSecret		Client Secret for the TeamViewer OAuth 2.0 connection
Scopes string Hidden Field scopes		TeamViewer Scopes.
Token URL string / Required Hidden Field tokenUrl	https://webapi.teamviewer.com/api/v1/oauth2/token	The OAuth 2.0 Token URL for TeamViewer

Data Sources

Select Device

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

Input	Notes
Connection connection / Required connection

Example Payload for Select Device

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

Select Group

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

Input	Notes
Connection connection / Required connection

Example Payload for Select Group

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

Select Managed Device

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

Input	Notes
Connection connection / Required connection

Example Payload for Select Managed Device

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

Actions

Assign Device

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

Input	Default	Notes	Example
Assign Mode string assign_mode		The assign mode for the device.	auto
Connection connection / Required connection
Current Password string current_device_password		The current password of the device.	password
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Device ID string / Required device_id		The ID of the device to retrieve.	123456
Enable Easy Access boolean enable_easy_access	false	Whether to enable easy access for the device.

Example Payload for Assign Device

{
  "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

Input	Default	Notes	Example
Client ID string / Required client_id		The client ID associated with your TeamViewer account.	123456
Client Secret password / Required client_secret		The client secret associated with your TeamViewer account.	yourclientsecret
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Email string / Required email		The email address associated with your TeamViewer account.	test@test.com
Language string / Required language		The language of the account holder.	en
Name string / Required name		The name of the account holder.	John Doe
Password password / Required password		The password associated with your TeamViewer account.	password

Example Payload for Create Account

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		The description of the contact.	This is my contact.
Email string / Required email		The email of the contact.	test@test.com
Group ID string / Required groupid		The ID of the group to which the contact belongs. Either groupid or groupName is required.	g3370655
Group Name string groupname		The name of the group to which the contact belongs. Either groupid or groupName is required.	My Group
Invite boolean invite	false	Whether to invite the contact to TeamViewer.
Name string name		The name of the contact.	John Doe

Example Payload for Create Contact

{
  "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

Input	Default	Notes	Example
Alias string alias		The alias of the device.	My Device
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		The description of the device.	This is my device.
Group ID string / Required groupid		The ID of the group to which the device belongs.	g3370655
Password string password		The password of the device.	password
Remote Control ID string / Required remotecontrol_id		The ID of the remote control to assign to the device.	123456

Example Payload for Create Device

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Name string / Required name		The name of the group.	My Group
Policy ID string policy_id		The policy ID of the group.	123456

Example Payload for Create Group

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Body code customBody		Custom fields to include in the request body.
Custom ID string customId		The custom ID of the session.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		The description of the session.	This is my session.
Group ID string groupid		The ID of the group to which the session belongs. Either groupid or groupName is required.	g337065
Group Name string groupname		The name of the group to which the session belongs. Either groupid or groupName is required.	My Group

Example Payload for Create Session

{
  "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"
  }
}

Delete Contact

Deletes a contact by its ID. | key: deleteContact

Input	Default	Notes	Example
Connection connection / Required connection
Contacts ID string / Required contactId		The ID of the contact to delete.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Delete Contact

{
  "data": "ACTION SUCCEEDED"
}

Delete Device

Deletes a device by its ID. | key: deleteDevice

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Device ID string / Required deviceId		The ID of the device to delete.	123456

Example Payload for Delete Device

{
  "data": "ACTION SUCCEEDED"
}

Delete Group

Deletes a group by its ID. | key: deleteGroup

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The ID of the group to delete.	123456

Example Payload for Delete Group

{
  "data": "ACTION SUCCEEDED"
}

Delete Managed Device

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Managed Device ID string / Required managedDeviceId		The ID of the managed device to delete.	123456

Example Payload for Delete Managed Device

{
  "data": "ACTION SUCCEEDED"
}

Get Account

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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Account

{
  "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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Account Tenant IDs

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

Get Contact

Returns a contact by its ID. | key: getContact

Input	Default	Notes	Example
Connection connection / Required connection
Contacts ID string / Required contactId		The ID of the contact to retrieve.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Contact

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Device ID string / Required deviceId		The ID of the device to retrieve.	123456

Example Payload for Get Device

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The ID of the group to retrieve.	123456

Example Payload for Get Group

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Managed Device ID string / Required managedDeviceId		The ID of the managed device to retrieve.	123456

Example Payload for Get Managed Device

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Device ID string / Required deviceId		The ID of the device to retrieve missing patches for.	123456

Example Payload for Get Missing Patches

{
  "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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Get Ping

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

Get Session

Returns a session by its ID. | key: getSession

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Session ID string / Required sessionId		The ID of the session to retrieve.	123456

Example Payload for Get Session

{
  "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"
  }
}

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	Whether to fetch all records or just the first page.
Pagination Token string paginationToken		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 string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Company Managed Devices

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query Parameters string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Contacts

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupid		The ID of the group to which the device belongs.	g3370655
Name string name		The name of the device.	My Device
Query Parameters string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2
Remote Control ID string remotecontrol_id		The ID of the remote control to assign to the device.	123456

Example Payload for List Devices

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query Parameters string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Groups

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	Whether to fetch all records or just the first page.
Pagination Token string paginationToken		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 string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Managed Devices

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Continuation Token string continuationToken		The continuation token from the previous response.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	Whether to fetch all records or just the first page.
Query Parameters string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Patch Management Device

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Query Parameters string Key Value List queryParams		The query parameters to include in the request.	key1=value1&key2=value2

Example Payload for List Sessions

{
  "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
  }
}

Raw Request

Send raw HTTP request to Teamviewer API | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enable this to log the request and response
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	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.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Scan Results Count

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

Input	Default	Notes	Example
Connection connection / Required connection
Continuation Token string continuation_token		The continuation token from the previous response.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Device ID List code / Required device_id_list		A list of device IDs to retrieve missing patches for.

Example Payload for Scan Results Count

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

Update Account

Updates an account. | key: updateAccount

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Email string email		The email address associated with your TeamViewer account.	test@test.com
Email Language string email_language		The language of the account holder.	en
Name string name		The name of the account holder.	John Doe
Old Password password oldpassword		The current password associated with your TeamViewer account.	password
Password password password		The password associated with your TeamViewer account.	password

Example Payload for Update Account

{
  "data": "ACTION SUCCEEDED"
}

Update Device

Updates a device by its ID. | key: updateDevice

Input	Default	Notes	Example
Alias string alias		The alias of the device.	My Device
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		The description of the device.	This is my device.
Device ID string / Required deviceId		The ID of the device to retrieve.	123456
Group ID string / Required groupid		The ID of the group to which the device belongs.	g3370655
Password string password		The password of the device.	password
Remote Control ID string / Required remotecontrol_id		The ID of the remote control to assign to the device.	123456

Example Payload for Update Device

{
  "data": "ACTION SUCCEEDED"
}

Update Group

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		The ID of the group to update.	123456
Name string name		The name of the group.	My Group
Policy ID string policy_id		The policy ID of the group.	123456

Example Payload for Update Group

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Managed Device ID string / Required managedDeviceId		The ID of the managed device to retrieve.	123456
Managed Group ID string managedGroupId		The ID of the managed group to associate with the managed device.	123456
Name string name		The name of the managed device.	My Device
TeamViewer Policy ID string teamviewerPolicyId		The TeamViewer policy ID of the managed device.	123456

Example Payload for Update Managed Device

{
  "data": "ACTION SUCCEEDED"
}

Update Session

Updates a session by its ID. | key: updateSession

Input	Default	Notes	Example
Connection connection / Required connection
Body code customBody		Custom fields to include in the request body.
Custom ID string customId		The custom ID of the session.	123456
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		The description of the session.	This is my session.
Group ID string groupid		The ID of the group to which the session belongs. Either groupid or groupName is required.	g337065
Group Name string groupname		The name of the group to which the session belongs. Either groupid or groupName is required.	My Group
Session ID string / Required sessionId		The ID of the session to retrieve.	123456

Example Payload for Update Session

{
  "data": "ACTION SUCCEEDED"
}

Connect to TeamViewer to automate your remote support tasks.

Description​

API Documentation​

Connections​

OAuth 2.0​

Data Sources​

Select Device​

Select Group​

Select Managed Device​

Actions​

Assign Device​

Create Account​

Create Contact​

Create Device​

Create Group​

Create Session​

Delete Contact​

Delete Device​

Delete Group​

Delete Managed Device​

Get Account​

Get Account Tenant IDs​

Get Contact​

Get Device​

Get Group​

Get Managed Device​

Get Missing Patches​

Get Ping​

Get Session​

List Company Managed Devices​

List Contacts​

List Devices​

List Groups​

List Managed Devices​

List Patch Management Device​

List Sessions​

Raw Request​

Scan Results Count​

Update Account​

Update Device​

Update Group​

Update Managed Device​

Update Session​