{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Preferences API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Preferences",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Meeting Preference Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the required [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the meeting preferences for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ]
          },
          "docs": "Retrieves meeting preferences for the authenticated user."
        },
        {
          "info": {
            "name": "Get Personal Meeting Room Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences/personalMeetingRoom",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the Personal Meeting Room options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ]
          },
          "docs": "Retrieves the Personal Meeting Room options for the authenticated user."
        },
        {
          "info": {
            "name": "Update Personal Meeting Room Options",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/meetingPreferences/personalMeetingRoom",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update Personal Meeting Room options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates Personal Meeting Room options for the authenticated user."
        },
        {
          "info": {
            "name": "Get Audio Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences/audio",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the audio options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ]
          },
          "docs": "Retrieves audio options for the authenticated user."
        },
        {
          "info": {
            "name": "Update Audio Options",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/meetingPreferences/audio",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update audio options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates audio options for the authenticated user."
        },
        {
          "info": {
            "name": "Get Video Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences/video",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the video options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved using [Get Site List](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ]
          },
          "docs": "Retrieves video options for the authenticated user."
        },
        {
          "info": {
            "name": "Update Video Options",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/meetingPreferences/video",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update video options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates video options for the authenticated user."
        },
        {
          "info": {
            "name": "Get Scheduling Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences/schedulingOptions",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return details of the scheduling options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ]
          },
          "docs": "Retrieves scheduling options for the authenticated user."
        },
        {
          "info": {
            "name": "Update Scheduling Options",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/meetingPreferences/schedulingOptions",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates scheduling options for the authenticated user.\n\n* If `delegateEmails` is null or not specified, the user's delegate emails are not changed. If `delegateEmails` is specified and not empty, the user's delegate emails are updated with the specified emails. If `delegateEmails` is specified as an empty array, the user's existing delegate emails are removed."
        },
        {
          "info": {
            "name": "Insert Delegate Emails",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/meetingPreferences/schedulingOptions/delegateEmails/insert",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Insert delegate emails for the authenticated user."
        },
        {
          "info": {
            "name": "Delete Delegate Emails",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/meetingPreferences/schedulingOptions/delegateEmails/delete",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update scheduling options for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. For individual use, if `siteUrl` is not specified, the query will use the default site of the user. For admin use, if `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the `siteUrl` parameter. All available Webex sites and default site of a user can be retrieved from [/meetingPreferences/sites](/docs/api/v1/meeting-preferences/get-site-list)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete delegate emails for the authenticated user."
        },
        {
          "info": {
            "name": "Get Site List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/meetingPreferences/sites",
            "params": [
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user and the API will return the list of Webex sites for that user."
              },
              {
                "name": "siteUrl",
                "value": "site4-example.webex.com",
                "type": "query",
                "description": "URL of the Webex site to query. If `siteUrl` is not specified, the query will use the default site for the admin's authorization token used to make the call."
              }
            ]
          },
          "docs": "Retrieves the list of Webex sites that the authenticated user is set up to use.\nWhen the admin tries to get the site list via `userEmail`, if `siteUrl` is not specified, the API searches the user ID from the admin's default site. If `siteUrl` is specified, the API searches the user ID from the specified site."
        },
        {
          "info": {
            "name": "Update Default Site",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/meetingPreferences/sites",
            "params": [
              {
                "name": "defaultSite",
                "value": "true",
                "type": "query",
                "description": "Whether or not to change user's default site. ***Note***: `defaultSite` should be set to true for the user's single default site"
              },
              {
                "name": "userEmail",
                "value": "john.andersen@example.com",
                "type": "query",
                "description": "Email address for the user. This parameter is only used if the user or application calling the API has the [admin-level scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will update default site for that user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the default site for the authenticated user."
        },
        {
          "info": {
            "name": "Batch Refresh Personal Meeting Room ID",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/admin/meetingPreferences/personalMeetingRoom/refreshId",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Refreshes personal room IDs automatically according to the current personal room ID rule of the target site or by the values specified by the admin user.\n\nThe new personal room IDs are generated by the site's settings automatically if `systemGenerated` is true; otherwise, replace the existing personal room IDs with the specified values if `systemGenerated` is false or not specified.\n\nIt may take up to 30 minutes to see the updated personal room ID on the Webex meeting page after refreshing the p"
        }
      ]
    }
  ],
  "bundled": true
}