openapi: 3.2.0
info:
  title: Webex ECM folder linking API
  version: 1.0.0
  description: 'Operations tagged ECM folder linking across 2 of this provider''s published API definitions: webex-ecm-folder-linking-api-openapi.yml,
    webex-messaging-openapi.json. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of webex-messaging-openapi.json, the provider's source document. Operations and schemas are
      the provider's, unmodified; only the partition is ours.
    derived_from: webex-messaging-openapi.json
    operation_coverage: 5/5
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-messaging.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-messaging.json
tags:
- name: ECM folder linking
paths:
  /room/linkedFolders:
    get:
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ECMFolderCollectionResponse'
              example:
                items:
                - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
                  roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                  roomType: group
                  driveId: '123'
                  itemId: '456'
                  defaultFolder: 'false'
                  displayName: OneDrive folder for shared documents
                  contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
                  creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                  created: '2015-10-18T14:26:16.203Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: List ECM folder
      operationId: List ECM folder
      description: Lists the ECM folder of a room specified by the `roomId` query parameter.
      tags:
      - ECM folder linking
      parameters:
      - name: roomId
        in: query
        description: ID of the room for which to list the ECM folder.
        required: true
        example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
        schema:
          type: string
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ECMFolder'
              example:
                id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
                roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                roomType: group
                driveId: '123'
                itemId: '456'
                defaultFolder: 'false'
                displayName: OneDrive folder for shared documents
                contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
                creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                created: '2015-10-18T14:26:16.203Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: Create an ECM folder configuration
      operationId: Create an ECM folder configuration
      description: Adds an existing ECM folder to a room as (default or reference) file storage. There is no data validation
        happening for the request. Please ensure the correct `driveId` and `itemId.` These can be collected from the MS Graph
        API. The `contentUrl` and `displayName` are used only for user convenience. The folder will be configured with the
        MS folder name as `displayName`, and the `contentURL` may be updated or corrected as needed. To assess final configuration,
        please make a GET request on the linkedFolder.
      tags:
      - ECM folder linking
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
              contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
              displayName: OneDrive folder for shared documents
              driveId: '123'
              itemId: '456'
              defaultFolder: 'false'
            schema:
              type: object
              required:
              - roomId
              - contentUrl
              - displayName
              - driveId
              - itemId
              - defaultFolder
              properties:
                roomId:
                  type: string
                  example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                  description: A unique identifier for the room.
                contentUrl:
                  type: string
                  example: https://cisco-my.sharepoint.com/personal/naalluri/123
                  description: URL of the ECM folder.
                displayName:
                  type: string
                  example: OneDrive folder for shared documents
                  description: This should match the folder name in the ECM backend.
                driveId:
                  type: string
                  example: '123'
                  description: Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs.
                itemId:
                  type: string
                  example: '456'
                  description: Sharepoint or OneDrive item id. It can be queried via MS Graph APIs.
                defaultFolder:
                  type: string
                  example: 'false'
                  description: Makes the folder the default storage for the space.
  /room/linkedFolders/{id}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ECMFolder'
              example:
                id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
                roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                roomType: group
                driveId: '123'
                itemId: '456'
                defaultFolder: 'false'
                displayName: OneDrive folder for shared documents
                contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
                creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                created: '2015-10-18T14:26:16.203Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: Get ECM Folder Details
      operationId: Get ECM Folder Details
      description: Get details for a room ECM folder with the specified folder id.
      tags:
      - ECM folder linking
      parameters:
      - name: id
        in: path
        description: The unique identifier for the folder.
        required: true
        example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
        schema:
          type: string
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ECMFolder'
              example:
                id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
                roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                roomType: group
                driveId: '123'
                itemId: '456'
                defaultFolder: 'false'
                displayName: OneDrive folder for shared documents
                contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
                creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
                created: '2015-10-18T14:26:16.203Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: Update an ECM Linked Folder
      operationId: Update an ECM Linked Folder
      description: Updates the configuration of the specified Room folder. There is no data validation happening for the request.
        Please ensure the correct `driveId` and `itemId.` These can be collected from the MS Graph API. The `contentUrl` and
        `displayName` are used only for user convenience. The folder will be configured with the MS folder name as `displayName`,
        and the `contentURL` may be updated or corrected as needed. To assess final configuration, please make a GET request
        on the linkedFolder.
      tags:
      - ECM folder linking
      parameters:
      - name: id
        in: path
        description: The unique identifier for the room folder.
        required: true
        example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
              contentUrl: https://cisco-my.sharepoint.com/personal/naalluri/123
              displayName: OneDrive folder for shared documents
              driveId: '123'
              itemId: '456'
              defaultFolder: 'false'
            schema:
              type: object
              required:
              - roomId
              - contentUrl
              - displayName
              - driveId
              - itemId
              - defaultFolder
              properties:
                roomId:
                  type: string
                  example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
                  description: ID of the room that contains the room tab in question.
                contentUrl:
                  type: string
                  example: https://cisco-my.sharepoint.com/personal/naalluri/123
                  description: Content URL of the folder.
                displayName:
                  type: string
                  example: OneDrive folder for shared documents
                  description: This should match the folder name in the ECM backend.
                driveId:
                  type: string
                  example: '123'
                  description: Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs.
                itemId:
                  type: string
                  example: '456'
                  description: Sharepoint or OneDrive item id. It can be queried via MS Graph APIs.
                defaultFolder:
                  type: string
                  example: 'false'
                  description: Makes the folder the default storage for the space.
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: Unlink an ECM linked folder
      operationId: Unlink an ECM linked folder
      description: Unlinks the room-linked folder with the specified ID from the space.
      tags:
      - ECM folder linking
      parameters:
      - name: id
        in: path
        description: The unique identifier for the folder to disassociate from the space.
        required: true
        example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
        schema:
          type: string
components:
  schemas:
    ECMFolderCollectionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ECMFolder'
    ECMFolder:
      type: object
      required:
      - driveId
      - itemId
      - displayName
      properties:
        id:
          type: string
          example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1RBQlMvZDg1ZTYwNj
          description: A unique identifier for the folder.
        roomId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
          description: A unique identifier for the room to which the folder should be linked to.
        roomType:
          type: string
          enum:
          - direct
          - group
          description: "The room type.\n * `direct` - 1:1 room\n * `group` - group room\n"
        driveId:
          type: string
          example: '123'
          description: Sharepoint or OneDrive drive id. It can be queried via MS Graph APIs.
        itemId:
          type: string
          example: '456'
          description: Sharepoint or OneDrive item id. It can be queried via MS Graph APIs.
        defaultFolder:
          type: string
          example: 'false'
          description: Indicates if this is the default content storage for the room.
        displayName:
          type: string
          example: OneDrive folder for shared documents
          description: This should match the folder name in the ECM backend.
        contentUrl:
          type: string
          example: https://cisco-my.sharepoint.com/personal/naalluri/123
          description: Folder's content URL.
        creatorId:
          type: string
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
          description: The person ID of the person who created this folder link.
        created:
          type: string
          example: '2015-10-18T14:26:16.203Z'
          description: The date and time when the folder link was created.
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps
x-refined-from:
- webex-ecm-folder-linking-api-openapi.yml
- webex-messaging-openapi.json