> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# webex
> Webex Messaging API
**Server path:** `/webex` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| [`webex_create_a_membership`](#webex_create_a_membership) | Create a Membership |
| [`webex_create_a_message`](#webex_create_a_message) | Create a Message |
| [`webex_create_a_person`](#webex_create_a_person) | Create a Person |
| [`webex_create_a_room`](#webex_create_a_room) | Create a Room |
| [`webex_create_a_room_tab`](#webex_create_a_room_tab) | Create a Room Tab |
| [`webex_create_a_team`](#webex_create_a_team) | Create a Team |
| [`webex_create_a_webhook`](#webex_create_a_webhook) | Create a Webhook |
| [`webex_create_an_attachment_action`](#webex_create_an_attachment_action) | Create an Attachment Action |
| [`webex_create_an_ecm_folder_configuration`](#webex_create_an_ecm_folder_configuration) | Create an ECM folder configuration |
| [`webex_create_team_membership`](#webex_create_team_membership) | Create a Team Membership |
| [`webex_delete_a_membership`](#webex_delete_a_membership) | Delete a Membership |
| [`webex_delete_a_message`](#webex_delete_a_message) | Delete a Message |
| [`webex_delete_a_person`](#webex_delete_a_person) | Delete a Person |
| [`webex_delete_a_room`](#webex_delete_a_room) | Delete a Room |
| [`webex_delete_a_room_tab`](#webex_delete_a_room_tab) | Delete a Room Tab |
| [`webex_delete_a_team`](#webex_delete_a_team) | Delete a Team |
| [`webex_delete_a_team_membership`](#webex_delete_a_team_membership) | Delete a Team Membership |
| [`webex_delete_a_webhook`](#webex_delete_a_webhook) | Delete a Webhook |
| [`webex_edit_a_message`](#webex_edit_a_message) | Edit a Message |
| [`webex_get_attachment_action_details`](#webex_get_attachment_action_details) | Get Attachment Action Details |
| [`webex_get_ecm_folder_details`](#webex_get_ecm_folder_details) | Get ECM Folder Details |
| [`webex_get_event_details`](#webex_get_event_details) | Get Event Details |
| [`webex_get_hdscluster_availability_details`](#webex_get_hdscluster_availability_details) | Get availability details for HDS cluster |
| [`webex_get_hdscluster_details`](#webex_get_hdscluster_details) | Get cluster details |
| [`webex_get_hdsmulti_tenant_organization_details`](#webex_get_hdsmulti_tenant_organization_details) | Get Multi-Tenant HDS organization details |
| [`webex_get_hdsnode_alarms`](#webex_get_hdsnode_alarms) | Get alarms for an HDS node |
| [`webex_get_hdsnode_details`](#webex_get_hdsnode_details) | Get node details |
| [`webex_get_hdsnode_resource_usage`](#webex_get_hdsnode_resource_usage) | Get resource usage for an HDS node |
| [`webex_get_hdsorganization_database_details`](#webex_get_hdsorganization_database_details) | Get database details for the HDS organization |
| [`webex_get_hdsorganization_details`](#webex_get_hdsorganization_details) | Get organization details |
| [`webex_get_membership_details`](#webex_get_membership_details) | Get Membership Details |
| [`webex_get_message_details`](#webex_get_message_details) | Get Message Details |
| [`webex_get_my_own_details`](#webex_get_my_own_details) | Get My Own Details |
| [`webex_get_network_test_results_for_hdsnode`](#webex_get_network_test_results_for_hdsnode) | Get test results for HDS node |
| [`webex_get_person_details`](#webex_get_person_details) | Get Person Details |
| [`webex_get_room_details`](#webex_get_room_details) | Get Room Details |
| [`webex_get_room_meeting_details`](#webex_get_room_meeting_details) | Get Room Meeting Details |
| [`webex_get_room_tab_details`](#webex_get_room_tab_details) | Get Room Tab Details |
| [`webex_get_team_details`](#webex_get_team_details) | Get Team Details |
| [`webex_get_team_membership_details`](#webex_get_team_membership_details) | Get Team Membership Details |
| [`webex_get_webhook_details`](#webex_get_webhook_details) | Get Webhook Details |
| [`webex_list_direct_messages`](#webex_list_direct_messages) | List Direct Messages |
| [`webex_list_ecm_folder`](#webex_list_ecm_folder) | List ECM folder |
| [`webex_list_events`](#webex_list_events) | List Events |
| [`webex_list_hdscluster_nodes`](#webex_list_hdscluster_nodes) | List nodes for an HDS cluster |
| [`webex_list_hdsorganization_clusters`](#webex_list_hdsorganization_clusters) | List clusters for an HDS organization |
| [`webex_list_memberships`](#webex_list_memberships) | List Memberships |
| [`webex_list_messages`](#webex_list_messages) | List Messages |
| [`webex_list_people`](#webex_list_people) | List People |
| [`webex_list_room_tabs`](#webex_list_room_tabs) | List Room Tabs |
| [`webex_list_rooms`](#webex_list_rooms) | List Rooms |
| [`webex_list_team_memberships`](#webex_list_team_memberships) | List Team Memberships |
| [`webex_list_teams`](#webex_list_teams) | List Teams |
| [`webex_list_webhooks`](#webex_list_webhooks) | List Webhooks |
| [`webex_unlink_an_ecm_linked_folder`](#webex_unlink_an_ecm_linked_folder) | Unlink an ECM linked folder |
| [`webex_update_a_membership`](#webex_update_a_membership) | Update a Membership |
| [`webex_update_a_person`](#webex_update_a_person) | Update a Person |
| [`webex_update_a_room`](#webex_update_a_room) | Update a Room |
| [`webex_update_a_room_tab`](#webex_update_a_room_tab) | Update a Room Tab |
| [`webex_update_a_team`](#webex_update_a_team) | Update a Team |
| [`webex_update_a_team_membership`](#webex_update_a_team_membership) | Update a Team Membership |
| [`webex_update_a_webhook`](#webex_update_a_webhook) | Update a Webhook |
| [`webex_update_an_ecm_linked_folder`](#webex_update_an_ecm_linked_folder) | Update an ECM Linked Folder |
***
## webex\_create\_a\_membership
Create a Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `isModerator` | boolean | No | — | Whether or not the participant is a room moderator. |
| `personEmail` | string | No | — | The email address of the person to add. Exactly one of personId or personEmail is required to identify the person. |
| `personId` | string | No | — | The ID of the person to add. Exactly one of personId or personEmail is required to identify the person. |
| `roomId` | string | Yes | — | The room ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"isModerator": {
"type": "boolean",
"description": "Whether or not the participant is a room moderator."
},
"personEmail": {
"type": "string",
"description": "The email address of the person to add. Exactly one of personId or personEmail is required to identify the person."
},
"personId": {
"type": "string",
"description": "The ID of the person to add. Exactly one of personId or personEmail is required to identify the person."
},
"roomId": {
"type": "string",
"description": "The room ID."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_create\_a\_message
Create a Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `attachments` | object\[] | No | — | Content attachments to attach to the message. Only one card per message is supported. See the Cards Guide for more information. |
| `files` | string\[] | No | — | The public URL to a binary file to be posted into the room. Only one file is allowed per message. Uploaded files are automatically converted into a format that all Webex clients can render. For the supported media types and the behavior of uploads, see the Message Attachments Guide. |
| `markdown` | string | No | — | The message, in Markdown format. The maximum message length is 7439 bytes. |
| `parentId` | string | No | — | The parent message to reply to. |
| `roomId` | string | No | — | The room ID to post the message to. Exactly one destination is required: roomId (for group spaces), toPersonId, or toPersonEmail (for 1:1 DMs). These are mutually exclusive. |
| `text` | string | No | — | The message, in plain text. If `markdown` is specified this parameter may be *optionally* used to provide alternate text for UI clients that do not support rich text. The maximum message length is 7439 bytes. |
| `toPersonEmail` | string | No | — | The email address of the person to send a 1:1 direct message to. Mutually exclusive with roomId and toPersonId — provide exactly one destination. |
| `toPersonId` | string | No | — | The person ID to send a 1:1 direct message to. Mutually exclusive with roomId and toPersonEmail — provide exactly one destination. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "object",
"description": "The content value"
}
}
},
"description": "Content attachments to attach to the message. Only one card per message is supported. See the [Cards Guide](/docs/api/guides/cards) for more information."
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The public URL to a binary file to be posted into the room. Only one file is allowed per message. Uploaded files are automatically converted into a format that all Webex clients can render. For the supported media types and the behavior of uploads, see the [Message Attachments Guide](/docs/basics#message-attachments)."
},
"markdown": {
"type": "string",
"description": "The message, in Markdown format. The maximum message length is 7439 bytes."
},
"parentId": {
"type": "string",
"description": "The parent message to reply to."
},
"roomId": {
"type": "string",
"description": "The room ID to post the message to. Exactly one destination is required: roomId (for group spaces), toPersonId, or toPersonEmail (for 1:1 DMs). These are mutually exclusive."
},
"text": {
"type": "string",
"description": "The message, in plain text. If `markdown` is specified this parameter may be *optionally* used to provide alternate text for UI clients that do not support rich text. The maximum message length is 7439 bytes."
},
"toPersonEmail": {
"type": "string",
"description": "The email address of the person to send a 1:1 direct message to. Mutually exclusive with roomId and toPersonId — provide exactly one destination."
},
"toPersonId": {
"type": "string",
"description": "The person ID to send a 1:1 direct message to. Mutually exclusive with roomId and toPersonEmail — provide exactly one destination."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_create\_a\_person
Create a Person
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callingData` | boolean | No | — | Include Webex Calling user details in the response. |
| `minResponse` | boolean | No | — | Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details. |
| `addresses` | object\[] | No | — | A person's addresses. |
| `avatar` | string | No | — | The URL to the person's avatar in PNG format. |
| `department` | string | No | — | The business department the user belongs to. |
| `displayName` | string | No | — | The full name of the person. |
| `emails` | string\[] | Yes | — | The email addresses of the person. Only one email address is allowed per person. |
| `extension` | string | No | — | Webex Calling extension of the person. This is only settable for a person with a Webex Calling license. |
| `firstName` | string | No | — | The first name of the person. |
| `lastName` | string | No | — | The last name of the person. |
| `licenses` | string\[] | No | — | An array of license strings allocated to this person. |
| `locationId` | string | No | — | The ID of the location for this person. |
| `manager` | string | No | — | A manager identifier. |
| `managerId` | string | No | — | Person ID of the manager. |
| `orgId` | string | No | — | The ID of the organization to which this person belongs. |
| `phoneNumbers` | object\[] | No | — | Phone numbers for the person. Only settable for Webex Calling. Requires a Webex Calling license. |
| `roles` | string\[] | No | — | An array of role strings representing the roles to which this admin user belongs. |
| `siteUrls` | string\[] | No | — | One or several site names where this user has an attendee role. Append `#attendee` to the sitename (e.g.: `mysite.webex.com#attendee`). |
| `title` | string | No | — | The person's title. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callingData": {
"type": "boolean",
"description": "Include Webex Calling user details in the response."
},
"minResponse": {
"type": "boolean",
"description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of address."
},
"country": {
"type": "string",
"description": "The user's country."
},
"locality": {
"type": "string",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"avatar": {
"type": "string",
"description": "The URL to the person's avatar in PNG format."
},
"department": {
"type": "string",
"description": "The business department the user belongs to."
},
"displayName": {
"type": "string",
"description": "The full name of the person."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email addresses of the person. Only one email address is allowed per person."
},
"extension": {
"type": "string",
"description": "Webex Calling extension of the person. This is only settable for a person with a Webex Calling license."
},
"firstName": {
"type": "string",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"description": "The last name of the person."
},
"licenses": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of license strings allocated to this person."
},
"locationId": {
"type": "string",
"description": "The ID of the location for this person."
},
"manager": {
"type": "string",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"description": "Person ID of the manager."
},
"orgId": {
"type": "string",
"description": "The ID of the organization to which this person belongs."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work"
],
"description": "The type of phone number."
},
"value": {
"type": "string",
"description": "The phone number."
}
}
},
"description": "Phone numbers for the person. Only settable for Webex Calling. Requires a Webex Calling license."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "One or several site names where this user has an attendee role. Append `#attendee` to the sitename (e.g.: `mysite.webex.com#attendee`)."
},
"title": {
"type": "string",
"description": "The person's title."
}
},
"required": [
"PCID",
"emails"
]
}
```
***
## webex\_create\_a\_room
Create a Room
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `classificationId` | string | No | — | The `classificationId` for the room. |
| `description` | string | No | — | The description of the space. |
| `isAnnouncementOnly` | boolean | No | — | Sets the space into announcement Mode. |
| `isLocked` | boolean | No | — | Set the space as locked/moderated and the creator becomes a moderator |
| `isPublic` | boolean | No | — | The room is public and therefore discoverable within the org. Anyone can find and join that room. When `true` the `description` must be filled in. |
| `teamId` | string | No | — | The ID for the team with which this room is associated. |
| `title` | string | Yes | — | A user-friendly name for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"classificationId": {
"type": "string",
"description": "The `classificationId` for the room."
},
"description": {
"type": "string",
"description": "The description of the space."
},
"isAnnouncementOnly": {
"type": "boolean",
"description": "Sets the space into announcement Mode."
},
"isLocked": {
"type": "boolean",
"description": "Set the space as locked/moderated and the creator becomes a moderator"
},
"isPublic": {
"type": "boolean",
"description": "The room is public and therefore discoverable within the org. Anyone can find and join that room. When `true` the `description` must be filled in."
},
"teamId": {
"type": "string",
"description": "The ID for the team with which this room is associated."
},
"title": {
"type": "string",
"description": "A user-friendly name for the room."
}
},
"required": [
"PCID",
"title"
]
}
```
***
## webex\_create\_a\_room\_tab
Create a Room Tab
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------------------------------------------- |
| `contentUrl` | string | Yes | — | URL of the Room Tab. Must use `https` protocol. |
| `displayName` | string | Yes | — | User-friendly name for the room tab. |
| `roomId` | string | Yes | — | A unique identifier for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contentUrl": {
"type": "string",
"description": "URL of the Room Tab. Must use `https` protocol."
},
"displayName": {
"type": "string",
"description": "User-friendly name for the room tab."
},
"roomId": {
"type": "string",
"description": "A unique identifier for the room."
}
},
"required": [
"PCID",
"contentUrl",
"displayName",
"roomId"
]
}
```
***
## webex\_create\_a\_team
Create a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------- |
| `description` | string | No | — | The teams description. |
| `name` | string | Yes | — | A user-friendly name for the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "The teams description."
},
"name": {
"type": "string",
"description": "A user-friendly name for the team."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## webex\_create\_a\_webhook
Create a Webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `event` | string | Yes | — | Event type for the webhook. \* `created` - An object is created. \* `updated` - An object is updated. \* `deleted` - An object is deleted. \* `started` - A meeting is started. \* `ended` - A meeting is ended. \* `joined` - A participant joined. \* `left` - A participant left. \* `migrated` - A room was migrated to a different geography. The roomId has changed. \* `authorized` - A Service App was authorized. \* `deauthorized` - A Service App was deauthorized. \* `statusChanged` - Status of admin batch job was changed. |
| `filter` | string | No | — | Filter that defines the webhook scope. See Filtering Webhooks for more information. Please note that if a filter of `hostEmail`, `hostUserId`, `ownerEmail` or `ownerId` is specified, `ownedBy` must be set to `org`. |
| `name` | string | Yes | — | A user-friendly name for the webhook. |
| `ownedBy` | string | No | — | Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`,`meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see inline file DLP) resources. |
| `resource` | string | Yes | — | Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for. \* `attachmentActions` - Attachment Actions resource. \* `dataSources` - data sources resource. \* `memberships` - Memberships resource. \* `messages` - Messages resource. \* `rooms` - Rooms resource. \* `meetings` - Meetings resource. \* `recordings` - Recordings resource. \* `convergedRecordings` - CallRecordings resource. \* `meetingParticipants` - Meeting Participants resource. \* `meetingTranscripts` - Meeting Transcripts resource. \* `telephony_calls` - Webex Calling call resources. \* `telephony_conference` - Webex Calling conference controls resource. \* `telephony_mwi` - Webex Calling voicemail message waiting indicator resource. \* `uc_counters` - Performance counter for a dedicated instance. \* `serviceApp` - Service App authorization notification. \* `adminBatchJobs` - Admin Batch Jobs notification. |
| `secret` | string | No | — | Secret used to generate payload signature. |
| `targetUrl` | string | Yes | — | URL that receives POST requests for each event. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event": {
"type": "string",
"description": "Event type for the webhook. * `created` - An object is created. * `updated` - An object is updated. * `deleted` - An object is deleted. * `started` - A meeting is started. * `ended` - A meeting is ended. * `joined` - A participant joined. * `left` - A participant left. * `migrated` - A room was migrated to a different geography. The roomId has changed. * `authorized` - A Service App was authorized. * `deauthorized` - A Service App was deauthorized. * `statusChanged` - Status of admin batch job was changed.",
"enum": [
"created",
"updated",
"deleted",
"started",
"ended",
"joined",
"left",
"migrated",
"authorized",
"deauthorized",
"statusChanged"
]
},
"filter": {
"type": "string",
"description": "Filter that defines the webhook scope. See [Filtering Webhooks](/docs/api/guides/webhooks#filtering-webhooks) for more information. Please note that if a filter of `hostEmail`, `hostUserId`, `ownerEmail` or `ownerId` is specified, `ownedBy` must be set to `org`."
},
"name": {
"type": "string",
"description": "A user-friendly name for the webhook."
},
"ownedBy": {
"type": "string",
"description": "Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`,`meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see [inline file DLP](/docs/api/guides/webex-real-time-file-dlp-basics)) resources."
},
"resource": {
"type": "string",
"description": "Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for. * `attachmentActions` - [Attachment Actions](/docs/api/v1/attachment-actions) resource. * `dataSources` - [data sources](/docs/api/v1/data-sources) resource. * `memberships` - [Memberships](/docs/api/v1/memberships) resource. * `messages` - [Messages](/docs/api/v1/messages) resource. * `rooms` - [Rooms](/docs/api/v1/rooms) resource. * `meetings` - [Meetings](/docs/api/v1/meetings) resource. * `recordings` - [Recordings](/docs/api/v1/recordings) resource. * `convergedRecordings` - [CallRecordings](/docs/api/v1/converged-recordings) resource. * `meetingParticipants` - [Meeting Participants](/docs/api/v1/meeting-participants) resource. * `meetingTranscripts` - [Meeting Transcripts](/docs/api/v1/meeting-transcripts) resource. * `telephony_calls` - [Webex Calling](/docs/webex-calling-overview) call resources. * `telephony_conference` - [Webex Calling](/docs/webex-calling-overview) conference controls resource. * `telephony_mwi` - [Webex Calling](/docs/webex-calling-overview) voicemail message waiting indicator resource. * `uc_counters` - Performance counter for a dedicated instance. * `serviceApp` - Service App authorization notification. * `adminBatchJobs` - Admin Batch Jobs notification.",
"enum": [
"attachmentActions",
"dataSources",
"memberships",
"messages",
"rooms",
"meetings",
"recordings",
"convergedRecordings",
"meetingParticipants",
"meetingTranscripts",
"telephony_calls",
"telephony_conference",
"telephony_mwi",
"uc_counters",
"serviceApp",
"adminBatchJobs"
]
},
"secret": {
"type": "string",
"description": "Secret used to generate payload signature."
},
"targetUrl": {
"type": "string",
"description": "URL that receives POST requests for each event."
}
},
"required": [
"PCID",
"event",
"name",
"resource",
"targetUrl"
]
}
```
***
## webex\_create\_an\_attachment\_action
Create an Attachment Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `inputs` | object | Yes | — | The attachment action's inputs. |
| `messageId` | string | Yes | — | The ID of the message which contains the attachment. |
| `type` | string | Yes | — | The type of action to perform. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"inputs": {
"type": "object",
"description": "The attachment action's inputs.",
"properties": {
"Name": {
"type": "string",
"description": "The name value"
},
"Url": {
"type": "string",
"description": "The url value"
},
"Email": {
"type": "string",
"description": "The email value"
},
"Tel": {
"type": "string",
"description": "The tel value"
}
}
},
"messageId": {
"type": "string",
"description": "The ID of the message which contains the attachment."
},
"type": {
"type": "string",
"description": "The type of action to perform.",
"enum": [
"submit"
]
}
},
"required": [
"PCID",
"inputs",
"messageId",
"type"
]
}
```
***
## webex\_create\_an\_ecm\_folder\_configuration
Create an ECM folder configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | --------------------------------------------------------------------- |
| `contentUrl` | string | Yes | — | URL of the ECM folder. |
| `defaultFolder` | string | Yes | — | Makes the folder the default storage for the space. |
| `displayName` | string | Yes | — | This should match the folder name in the ECM backend. |
| `driveId` | string | Yes | — | Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs. |
| `itemId` | string | Yes | — | Sharepoint or OneDrive item id. It can be queried via MS Graph APIs. |
| `roomId` | string | Yes | — | A unique identifier for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contentUrl": {
"type": "string",
"description": "URL of the ECM folder."
},
"defaultFolder": {
"type": "string",
"description": "Makes the folder the default storage for the space."
},
"displayName": {
"type": "string",
"description": "This should match the folder name in the ECM backend."
},
"driveId": {
"type": "string",
"description": "Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs."
},
"itemId": {
"type": "string",
"description": "Sharepoint or OneDrive item id. It can be queried via MS Graph APIs."
},
"roomId": {
"type": "string",
"description": "A unique identifier for the room."
}
},
"required": [
"PCID",
"contentUrl",
"defaultFolder",
"displayName",
"driveId",
"itemId",
"roomId"
]
}
```
***
## webex\_create\_team\_membership
Create a Team Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `isModerator` | boolean | No | — | Whether or not the participant is a team moderator. |
| `personEmail` | string | No | — | The email address of the person to add. Exactly one of personId or personEmail is required to identify the person. |
| `personId` | string | No | — | The ID of the person to add. Exactly one of personId or personEmail is required to identify the person. |
| `teamId` | string | Yes | — | The team ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"isModerator": {
"type": "boolean",
"description": "Whether or not the participant is a team moderator."
},
"personEmail": {
"type": "string",
"description": "The email address of the person to add. Exactly one of personId or personEmail is required to identify the person."
},
"personId": {
"type": "string",
"description": "The ID of the person to add. Exactly one of personId or personEmail is required to identify the person."
},
"teamId": {
"type": "string",
"description": "The team ID."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## webex\_delete\_a\_membership
Delete a Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------- |
| `membershipId` | string | Yes | — | The unique identifier for the membership. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the membership."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_delete\_a\_message
Delete a Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `messageId` | string | Yes | — | The unique identifier for the message. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "The unique identifier for the message."
}
},
"required": [
"PCID",
"messageId"
]
}
```
***
## webex\_delete\_a\_person
Delete a Person
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------------------------- |
| `personId` | string | Yes | — | A unique identifier for the person. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"personId": {
"type": "string",
"description": "A unique identifier for the person."
}
},
"required": [
"PCID",
"personId"
]
}
```
***
## webex\_delete\_a\_room
Delete a Room
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `roomId` | string | Yes | — | The unique identifier for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "The unique identifier for the room."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_delete\_a\_room\_tab
Delete a Room Tab
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the Room Tab to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the Room Tab to delete."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_delete\_a\_team
Delete a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `teamId` | string | Yes | — | The unique identifier for the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "The unique identifier for the team."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## webex\_delete\_a\_team\_membership
Delete a Team Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------- |
| `membershipId` | string | Yes | — | The unique identifier for the team membership. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the team membership."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_delete\_a\_webhook
Delete a Webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `webhookId` | string | Yes | — | The unique identifier for the webhook. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "string",
"description": "The unique identifier for the webhook."
}
},
"required": [
"PCID",
"webhookId"
]
}
```
***
## webex\_edit\_a\_message
Edit a Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `messageId` | string | Yes | — | The unique identifier for the message. |
| `markdown` | string | No | — | The message, in Markdown format. If this attribute is set ensure that the request does NOT contain an `html` attribute. |
| `roomId` | string | Yes | — | The room ID of the message. |
| `text` | string | No | — | The message, in plain text. If `markdown` is specified this parameter may be *optionally* used to provide alternate text for UI clients that do not support rich text. The maximum message length is 7439 bytes. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "The unique identifier for the message."
},
"markdown": {
"type": "string",
"description": "The message, in Markdown format. If this attribute is set ensure that the request does NOT contain an `html` attribute."
},
"roomId": {
"type": "string",
"description": "The room ID of the message."
},
"text": {
"type": "string",
"description": "The message, in plain text. If `markdown` is specified this parameter may be *optionally* used to provide alternate text for UI clients that do not support rich text. The maximum message length is 7439 bytes."
}
},
"required": [
"PCID",
"messageId",
"roomId"
]
}
```
***
## webex\_get\_attachment\_action\_details
Get Attachment Action Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------- |
| `id` | string | Yes | — | A unique identifier for the attachment action. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "A unique identifier for the attachment action."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_get\_ecm\_folder\_details
Get ECM Folder Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the folder. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the folder."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_get\_event\_details
Get Event Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------ |
| `eventId` | string | Yes | — | The unique identifier for the event. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventId": {
"type": "string",
"description": "The unique identifier for the event."
}
},
"required": [
"PCID",
"eventId"
]
}
```
***
## webex\_get\_hdscluster\_availability\_details
Get availability details for HDS cluster
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `clusterId` | string | Yes | — | Unique ID of the HDS cluster. |
| `from` | string | Yes | — | The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time. |
| `to` | string | Yes | — | The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clusterId": {
"type": "string",
"description": "Unique ID of the HDS cluster."
},
"from": {
"type": "string",
"description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time."
},
"to": {
"type": "string",
"description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"required": [
"PCID",
"clusterId",
"from",
"to"
]
}
```
***
## webex\_get\_hdscluster\_details
Get cluster details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------- |
| `clusterId` | string | Yes | — | Unique ID of the HDS cluster. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clusterId": {
"type": "string",
"description": "Unique ID of the HDS cluster."
}
},
"required": [
"PCID",
"clusterId"
]
}
```
***
## webex\_get\_hdsmulti\_tenant\_organization\_details
Get Multi-Tenant HDS organization details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------------------------- |
| `organizationId` | string | Yes | — | Unique ID of the HDS organization. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "string",
"description": "Unique ID of the HDS organization."
}
},
"required": [
"PCID",
"organizationId"
]
}
```
***
## webex\_get\_hdsnode\_alarms
Get alarms for an HDS node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | Unique ID of the HDS node. |
| `from` | string | Yes | — | The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. |
| `to` | string | Yes | — | The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "Unique ID of the HDS node."
},
"from": {
"type": "string",
"description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"to": {
"type": "string",
"description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"required": [
"PCID",
"nodeId",
"from",
"to"
]
}
```
***
## webex\_get\_hdsnode\_details
Get node details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------- |
| `nodeId` | string | Yes | — | Unique ID of the HDS node |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "Unique ID of the HDS node"
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## webex\_get\_hdsnode\_resource\_usage
Get resource usage for an HDS node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | Unique ID of the HDS node. |
| `from` | string | Yes | — | The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. |
| `to` | string | Yes | — | The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "Unique ID of the HDS node."
},
"from": {
"type": "string",
"description": "The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"to": {
"type": "string",
"description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"required": [
"PCID",
"nodeId",
"from",
"to"
]
}
```
***
## webex\_get\_hdsorganization\_database\_details
Get database details for the HDS organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | --------------------------------- |
| `organizationId` | string | Yes | — | Unique ID of the HDS organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "string",
"description": "Unique ID of the HDS organization"
}
},
"required": [
"PCID",
"organizationId"
]
}
```
***
## webex\_get\_hdsorganization\_details
Get organization details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------------------------- |
| `organizationId` | string | Yes | — | Unique ID of the HDS organization. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "string",
"description": "Unique ID of the HDS organization."
}
},
"required": [
"PCID",
"organizationId"
]
}
```
***
## webex\_get\_membership\_details
Get Membership Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------- |
| `membershipId` | string | Yes | — | The unique identifier for the membership. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the membership."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_get\_message\_details
Get Message Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `messageId` | string | Yes | — | The unique identifier for the message. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "The unique identifier for the message."
}
},
"required": [
"PCID",
"messageId"
]
}
```
***
## webex\_get\_my\_own\_details
Get My Own Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------- |
| `callingData` | boolean | No | — | Include Webex Calling user details in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"callingData": {
"type": "boolean",
"description": "Include Webex Calling user details in the response."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_get\_network\_test\_results\_for\_hdsnode
Get test results for HDS node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------- |
| `nodeId` | string | Yes | — | Unique ID of the HDS node. |
| `triggerType` | string | No | — | Trigger type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "Unique ID of the HDS node."
},
"triggerType": {
"type": "string",
"description": "Trigger type.",
"enum": [
"OnDemand",
"Periodic",
"All"
]
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## webex\_get\_person\_details
Get Person Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------- |
| `personId` | string | Yes | — | A unique identifier for the person. |
| `callingData` | boolean | No | — | Include Webex Calling user details in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"personId": {
"type": "string",
"description": "A unique identifier for the person."
},
"callingData": {
"type": "boolean",
"description": "Include Webex Calling user details in the response."
}
},
"required": [
"PCID",
"personId"
]
}
```
***
## webex\_get\_room\_details
Get Room Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `roomId` | string | Yes | — | The unique identifier for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "The unique identifier for the room."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_get\_room\_meeting\_details
Get Room Meeting Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `roomId` | string | Yes | — | The unique identifier for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "The unique identifier for the room."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_get\_room\_tab\_details
Get Room Tab Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the Room Tab. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the Room Tab."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_get\_team\_details
Get Team Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------- |
| `teamId` | string | Yes | — | The unique identifier for the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "The unique identifier for the team."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## webex\_get\_team\_membership\_details
Get Team Membership Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------- |
| `membershipId` | string | Yes | — | The unique identifier for the team membership. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the team membership."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_get\_webhook\_details
Get Webhook Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `webhookId` | string | Yes | — | The unique identifier for the webhook. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "string",
"description": "The unique identifier for the webhook."
}
},
"required": [
"PCID",
"webhookId"
]
}
```
***
## webex\_list\_direct\_messages
List Direct Messages
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------- |
| `parentId` | string | No | — | List messages with a parent, by ID. |
| `personId` | string | No | — | List messages in a 1:1 room, by person ID. |
| `personEmail` | string | No | — | List messages in a 1:1 room, by person email. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"parentId": {
"type": "string",
"description": "List messages with a parent, by ID."
},
"personId": {
"type": "string",
"description": "List messages in a 1:1 room, by person ID."
},
"personEmail": {
"type": "string",
"description": "List messages in a 1:1 room, by person email."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_ecm\_folder
List ECM folder
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------ |
| `roomId` | string | Yes | — | ID of the room for which to list the ECM folder. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "ID of the room for which to list the ECM folder."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_list\_events
List Events
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `resource` | string | No | — | List events with a specific resource type. |
| `type` | string | No | — | List events with a specific event type. |
| `actorId` | string | No | — | List events performed by this person, by person ID. |
| `from` | string | No | — | List events which occurred after a specific date and time. |
| `to` | string | No | — | List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time. |
| `max` | number | No | — | Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive. |
| `serviceType` | string | No | — | List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"resource": {
"type": "string",
"description": "List events with a specific resource type.",
"enum": [
"attachmentActions",
"businessTexts",
"call_records",
"convergedRecordings",
"file_transcodings",
"files",
"meetingMessages",
"meetings",
"meetingTranscripts",
"memberships",
"messages",
"rooms",
"tabs"
]
},
"type": {
"type": "string",
"description": "List events with a specific event type.",
"enum": [
"created",
"updated",
"deleted",
"ended"
]
},
"actorId": {
"type": "string",
"description": "List events performed by this person, by person ID."
},
"from": {
"type": "string",
"description": "List events which occurred after a specific date and time."
},
"to": {
"type": "string",
"description": "List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time."
},
"max": {
"type": "number",
"description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive."
},
"serviceType": {
"type": "string",
"description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.",
"enum": [
"calling"
]
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_hdscluster\_nodes
List nodes for an HDS cluster
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------- |
| `clusterId` | string | Yes | — | Unique ID of the HDS cluster. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clusterId": {
"type": "string",
"description": "Unique ID of the HDS cluster."
}
},
"required": [
"PCID",
"clusterId"
]
}
```
***
## webex\_list\_hdsorganization\_clusters
List clusters for an HDS organization
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------------------------- |
| `organizationId` | string | Yes | — | Unique ID of the HDS organization. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "string",
"description": "Unique ID of the HDS organization."
}
},
"required": [
"PCID",
"organizationId"
]
}
```
***
## webex\_list\_memberships
List Memberships
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `roomId` | string | No | — | List memberships associated with a room, by ID. |
| `personId` | string | No | — | List memberships associated with a person, by ID. The `roomId` parameter is required when using this parameter. |
| `personEmail` | string | No | — | List memberships associated with a person, by email address. The `roomId` parameter is required when using this parameter. |
| `max` | number | No | — | Limit the maximum number of memberships in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "List memberships associated with a room, by ID."
},
"personId": {
"type": "string",
"description": "List memberships associated with a person, by ID. The `roomId` parameter is required when using this parameter."
},
"personEmail": {
"type": "string",
"description": "List memberships associated with a person, by email address. The `roomId` parameter is required when using this parameter."
},
"max": {
"type": "number",
"description": "Limit the maximum number of memberships in the response."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_messages
List Messages
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `roomId` | string | Yes | — | List messages in a room, by ID. |
| `parentId` | string | No | — | List messages with a parent, by ID. |
| `mentionedPeople` | string\[] | No | — | List messages with these people mentioned, by ID. Use `me` as a shorthand for the current API user. Only `me` or the person ID of the current user may be specified. Bots must include this parameter to list messages in group rooms (spaces). |
| `before` | string | No | — | List messages sent before a date and time. |
| `beforeMessage` | string | No | — | List messages sent before a message, by ID. |
| `max` | number | No | — | Limit the maximum number of messages in the response. Cannot exceed 100 if used with `mentionedPeople`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "List messages in a room, by ID."
},
"parentId": {
"type": "string",
"description": "List messages with a parent, by ID."
},
"mentionedPeople": {
"type": "array",
"items": {
"type": "string"
},
"description": "List messages with these people mentioned, by ID. Use `me` as a shorthand for the current API user. Only `me` or the person ID of the current user may be specified. Bots must include this parameter to list messages in group rooms (spaces)."
},
"before": {
"type": "string",
"description": "List messages sent before a date and time."
},
"beforeMessage": {
"type": "string",
"description": "List messages sent before a message, by ID."
},
"max": {
"type": "number",
"description": "Limit the maximum number of messages in the response. Cannot exceed 100 if used with `mentionedPeople`."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_list\_people
List People
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `email` | string | No | — | List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org. |
| `displayName` | string | No | — | List people whose name starts with this string. For non-admin requests, either this or email are required. |
| `id` | string | No | — | List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response. |
| `orgId` | string | No | — | List people in this organization. Only admin users of another organization (such as partners) may use this parameter. |
| `roles` | string | No | — | List of roleIds separated by commas. |
| `callingData` | boolean | No | — | Include Webex Calling user details in the response. |
| `locationId` | string | No | — | List people present in this location. |
| `max` | number | No | — | Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50. |
| `excludeStatus` | boolean | No | — | Omit people status/availability to enhance query performance. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org."
},
"displayName": {
"type": "string",
"description": "List people whose name starts with this string. For non-admin requests, either this or email are required."
},
"id": {
"type": "string",
"description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response."
},
"orgId": {
"type": "string",
"description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
"roles": {
"type": "string",
"description": "List of roleIds separated by commas."
},
"callingData": {
"type": "boolean",
"description": "Include Webex Calling user details in the response."
},
"locationId": {
"type": "string",
"description": "List people present in this location."
},
"max": {
"type": "number",
"description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50."
},
"excludeStatus": {
"type": "boolean",
"description": "Omit people status/availability to enhance query performance."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_room\_tabs
List Room Tabs
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------- |
| `roomId` | string | Yes | — | ID of the room for which to list room tabs. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "ID of the room for which to list room tabs."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_list\_rooms
List Rooms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| `teamId` | string | No | — | List rooms associated with a team, by ID. Cannot be set in combination with `orgPublicSpaces`. |
| `type` | string | No | — | List rooms by type. Cannot be set in combination with `orgPublicSpaces`. |
| `orgPublicSpaces` | boolean | No | — | Shows the org's public spaces joined and unjoined. When set the result list is sorted by the `madePublic` timestamp. |
| `from` | string | No | — | Filters rooms, that were made public after this time. See `madePublic` timestamp |
| `to` | string | No | — | Filters rooms, that were made public before this time. See `maePublic` timestamp |
| `sortBy` | string | No | — | Sort results. Cannot be set in combination with `orgPublicSpaces`. |
| `max` | number | No | — | Limit the maximum number of rooms in the response. Value must be between 1 and 1000, inclusive. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "List rooms associated with a team, by ID. Cannot be set in combination with `orgPublicSpaces`."
},
"type": {
"type": "string",
"description": "List rooms by type. Cannot be set in combination with `orgPublicSpaces`.",
"enum": [
"direct",
"group"
]
},
"orgPublicSpaces": {
"type": "boolean",
"description": "Shows the org's public spaces joined and unjoined. When set the result list is sorted by the `madePublic` timestamp."
},
"from": {
"type": "string",
"description": "Filters rooms, that were made public after this time. See `madePublic` timestamp"
},
"to": {
"type": "string",
"description": "Filters rooms, that were made public before this time. See `maePublic` timestamp"
},
"sortBy": {
"type": "string",
"description": "Sort results. Cannot be set in combination with `orgPublicSpaces`.",
"enum": [
"id",
"lastactivity",
"created"
]
},
"max": {
"type": "number",
"description": "Limit the maximum number of rooms in the response. Value must be between 1 and 1000, inclusive."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_team\_memberships
List Team Memberships
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `teamId` | string | Yes | — | List memberships for a team, by ID. |
| `max` | number | No | — | Limit the maximum number of team memberships in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "List memberships for a team, by ID."
},
"max": {
"type": "number",
"description": "Limit the maximum number of team memberships in the response."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## webex\_list\_teams
List Teams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------- |
| `max` | number | No | — | Limit the maximum number of teams in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"max": {
"type": "number",
"description": "Limit the maximum number of teams in the response."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_list\_webhooks
List Webhooks
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `max` | number | No | — | Limit the maximum number of webhooks in the response. |
| `ownedBy` | string | No | — | Limit the result list to org wide webhooks. Only allowed value is `org`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"max": {
"type": "number",
"description": "Limit the maximum number of webhooks in the response."
},
"ownedBy": {
"type": "string",
"description": "Limit the result list to org wide webhooks. Only allowed value is `org`."
}
},
"required": [
"PCID"
]
}
```
***
## webex\_unlink\_an\_ecm\_linked\_folder
Unlink an ECM linked folder
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the folder to disassociate from the space. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the folder to disassociate from the space."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_update\_a\_membership
Update a Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `membershipId` | string | Yes | — | The unique identifier for the membership. |
| `isModerator` | boolean | No | — | Whether or not the participant is a room moderator. |
| `isRoomHidden` | boolean | No | — | When set to true, hides direct spaces in the teams client. Any new message will make the room visible again. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the membership."
},
"isModerator": {
"type": "boolean",
"description": "Whether or not the participant is a room moderator."
},
"isRoomHidden": {
"type": "boolean",
"description": "When set to true, hides direct spaces in the teams client. Any new message will make the room visible again."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_update\_a\_person
Update a Person
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `personId` | string | Yes | — | A unique identifier for the person. |
| `callingData` | boolean | No | — | Include Webex Calling user details in the response. |
| `showAllTypes` | boolean | No | — | Include additional user data like `#attendee` role. |
| `minResponse` | boolean | No | — | Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details. |
| `addresses` | object\[] | No | — | A person's addresses. |
| `avatar` | string | No | — | The URL to the person's avatar in PNG format. |
| `department` | string | No | — | The business department the user belongs to. |
| `displayName` | string | No | — | The full name of the person. |
| `emails` | string\[] | No | — | The email addresses of the person. Only one email address is allowed per person. |
| `extension` | string | No | — | Webex Calling extension of the person. This is only settable for a person with a Webex Calling license. |
| `firstName` | string | No | — | The first name of the person. |
| `lastName` | string | No | — | The last name of the person. |
| `licenses` | string\[] | No | — | An array of license strings allocated to this person. |
| `locationId` | string | No | — | The ID of the location for this person. |
| `loginEnabled` | boolean | No | — | Whether or not the user is allowed to use Webex. This property is only accessible if the authenticated user is an admin user for the person's organization. |
| `manager` | string | No | — | A manager identifier. |
| `managerId` | string | No | — | Person ID of the manager. |
| `nickName` | string | No | — | The nickname of the person if configured. This cannot be overwritten and instead will be set to the firstName automatically in update requests. |
| `orgId` | string | No | — | The ID of the organization to which this person belongs. |
| `phoneNumbers` | object\[] | No | — | Phone numbers for the person. Can only be set for Webex Calling. Needs a Webex Calling license. |
| `roles` | string\[] | No | — | An array of role strings representing the roles to which this admin user belongs. |
| `siteUrls` | string\[] | No | — | One or several site names where this user has a role (host or attendee). Append `#attendee` to the site name to designate the attendee role on that site. |
| `title` | string | No | — | The person's title. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"personId": {
"type": "string",
"description": "A unique identifier for the person."
},
"callingData": {
"type": "boolean",
"description": "Include Webex Calling user details in the response."
},
"showAllTypes": {
"type": "boolean",
"description": "Include additional user data like `#attendee` role."
},
"minResponse": {
"type": "boolean",
"description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of address."
},
"country": {
"type": "string",
"description": "The user's country."
},
"locality": {
"type": "string",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"avatar": {
"type": "string",
"description": "The URL to the person's avatar in PNG format."
},
"department": {
"type": "string",
"description": "The business department the user belongs to."
},
"displayName": {
"type": "string",
"description": "The full name of the person."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "The email addresses of the person. Only one email address is allowed per person."
},
"extension": {
"type": "string",
"description": "Webex Calling extension of the person. This is only settable for a person with a Webex Calling license."
},
"firstName": {
"type": "string",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"description": "The last name of the person."
},
"licenses": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of license strings allocated to this person."
},
"locationId": {
"type": "string",
"description": "The ID of the location for this person."
},
"loginEnabled": {
"type": "boolean",
"description": "Whether or not the user is allowed to use Webex. This property is only accessible if the authenticated user is an admin user for the person's organization."
},
"manager": {
"type": "string",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"description": "Person ID of the manager."
},
"nickName": {
"type": "string",
"description": "The nickname of the person if configured. This cannot be overwritten and instead will be set to the firstName automatically in update requests."
},
"orgId": {
"type": "string",
"description": "The ID of the organization to which this person belongs."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work"
],
"description": "The type of phone number."
},
"value": {
"type": "string",
"description": "The phone number."
}
}
},
"description": "Phone numbers for the person. Can only be set for Webex Calling. Needs a Webex Calling license."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "One or several site names where this user has a role (host or attendee). Append `#attendee` to the site name to designate the attendee role on that site."
},
"title": {
"type": "string",
"description": "The person's title."
}
},
"required": [
"PCID",
"personId"
]
}
```
***
## webex\_update\_a\_room
Update a Room
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `roomId` | string | Yes | — | The unique identifier for the room. |
| `classificationId` | string | No | — | The classificationId for the room. |
| `description` | string | No | — | The description of the space. |
| `isAnnouncementOnly` | boolean | No | — | Sets the space into Announcement Mode or clears the Anouncement Mode (`false`) |
| `isLocked` | boolean | No | — | Set the space as locked/moderated and the creator becomes a moderator |
| `isPublic` | boolean | No | — | The room is public and therefore discoverable within the org. Anyone can find and join that room. When `true` the `description` must be filled in. |
| `isReadOnly` | boolean | No | — | A compliance officer can set a direct room as read-only, which will disallow any new information exchanges in this space, while maintaing historical data. |
| `teamId` | string | No | — | The teamId to which this space should be assigned. Only unowned spaces can be assigned to a team. Assignment between teams is unsupported. |
| `title` | string | No | — | A user-friendly name for the room. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roomId": {
"type": "string",
"description": "The unique identifier for the room."
},
"classificationId": {
"type": "string",
"description": "The classificationId for the room."
},
"description": {
"type": "string",
"description": "The description of the space."
},
"isAnnouncementOnly": {
"type": "boolean",
"description": "Sets the space into Announcement Mode or clears the Anouncement Mode (`false`)"
},
"isLocked": {
"type": "boolean",
"description": "Set the space as locked/moderated and the creator becomes a moderator"
},
"isPublic": {
"type": "boolean",
"description": "The room is public and therefore discoverable within the org. Anyone can find and join that room. When `true` the `description` must be filled in."
},
"isReadOnly": {
"type": "boolean",
"description": "A compliance officer can set a direct room as read-only, which will disallow any new information exchanges in this space, while maintaing historical data."
},
"teamId": {
"type": "string",
"description": "The teamId to which this space should be assigned. Only unowned spaces can be assigned to a team. Assignment between teams is unsupported."
},
"title": {
"type": "string",
"description": "A user-friendly name for the room."
}
},
"required": [
"PCID",
"roomId"
]
}
```
***
## webex\_update\_a\_room\_tab
Update a Room Tab
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the Room Tab. |
| `contentUrl` | string | No | — | Content URL of the Room Tab. URL must use `https` protocol. |
| `displayName` | string | No | — | User-friendly name for the room tab. |
| `roomId` | string | No | — | ID of the room that contains the room tab in question. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the Room Tab."
},
"contentUrl": {
"type": "string",
"description": "Content URL of the Room Tab. URL must use `https` protocol."
},
"displayName": {
"type": "string",
"description": "User-friendly name for the room tab."
},
"roomId": {
"type": "string",
"description": "ID of the room that contains the room tab in question."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## webex\_update\_a\_team
Update a Team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------------------------------- |
| `teamId` | string | Yes | — | The unique identifier for the team. |
| `description` | string | No | — | The teams description. |
| `name` | string | No | — | A user-friendly name for the team. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "The unique identifier for the team."
},
"description": {
"type": "string",
"description": "The teams description."
},
"name": {
"type": "string",
"description": "A user-friendly name for the team."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## webex\_update\_a\_team\_membership
Update a Team Membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------------------------- |
| `membershipId` | string | Yes | — | The unique identifier for the team membership. |
| `isModerator` | boolean | No | — | Whether or not the participant is a team moderator. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"membershipId": {
"type": "string",
"description": "The unique identifier for the team membership."
},
"isModerator": {
"type": "boolean",
"description": "Whether or not the participant is a team moderator."
}
},
"required": [
"PCID",
"membershipId"
]
}
```
***
## webex\_update\_a\_webhook
Update a Webhook
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `webhookId` | string | Yes | — | The unique identifier for the webhook. |
| `name` | string | No | — | A user-friendly name for the webhook. |
| `ownedBy` | string | No | — | Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see inline file DLP) resources. |
| `secret` | string | No | — | Secret used to generate payload signature. |
| `status` | string | No | — | Status of the webhook. Use "active" to reactivate a disabled webhook. |
| `targetUrl` | string | No | — | URL that receives POST requests for each event. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhookId": {
"type": "string",
"description": "The unique identifier for the webhook."
},
"name": {
"type": "string",
"description": "A user-friendly name for the webhook."
},
"ownedBy": {
"type": "string",
"description": "Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see [inline file DLP](/docs/api/guides/webex-real-time-file-dlp-basics)) resources."
},
"secret": {
"type": "string",
"description": "Secret used to generate payload signature."
},
"status": {
"type": "string",
"description": "Status of the webhook. Use \"active\" to reactivate a disabled webhook.",
"enum": [
"active"
]
},
"targetUrl": {
"type": "string",
"description": "URL that receives POST requests for each event."
}
},
"required": [
"PCID",
"webhookId"
]
}
```
***
## webex\_update\_an\_ecm\_linked\_folder
Update an ECM Linked Folder
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | --------------------------------------------------------------------- |
| `id` | string | Yes | — | The unique identifier for the room folder. |
| `contentUrl` | string | No | — | Content URL of the folder. |
| `defaultFolder` | string | No | — | Makes the folder the default storage for the space. |
| `displayName` | string | No | — | This should match the folder name in the ECM backend. |
| `driveId` | string | No | — | Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs. |
| `itemId` | string | No | — | Sharepoint or OneDrive item id. It can be queried via MS Graph APIs. |
| `roomId` | string | No | — | ID of the room that contains the room tab in question. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique identifier for the room folder."
},
"contentUrl": {
"type": "string",
"description": "Content URL of the folder."
},
"defaultFolder": {
"type": "string",
"description": "Makes the folder the default storage for the space."
},
"displayName": {
"type": "string",
"description": "This should match the folder name in the ECM backend."
},
"driveId": {
"type": "string",
"description": "Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs."
},
"itemId": {
"type": "string",
"description": "Sharepoint or OneDrive item id. It can be queried via MS Graph APIs."
},
"roomId": {
"type": "string",
"description": "ID of the room that contains the room tab in question."
}
},
"required": [
"PCID",
"id"
]
}
```