Webex · Schema

PostCommonLocationObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum.
timeZone	string	Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format.
preferredLanguage	string	Default email language.
announcementLanguage	string	Location's phone announcement language.
address	object	The address of the location.
latitude	string	Latitude
longitude	string	Longitude
notes	string	Notes

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostCommonLocationObject",
  "title": "PostCommonLocationObject",
  "type": "object",
  "required": [
    "name",
    "timeZone",
    "preferredLanguage",
    "announcementLanguage",
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Denver",
      "description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
    },
    "timeZone": {
      "type": "string",
      "example": "America/Chicago",
      "description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
    },
    "preferredLanguage": {
      "type": "string",
      "example": "en_us",
      "description": "Default email language."
    },
    "announcementLanguage": {
      "type": "string",
      "example": "fr_fr",
      "description": "Location's phone announcement language."
    },
    "address": {
      "type": "object",
      "required": [
        "address1",
        "city",
        "state",
        "postalCode",
        "country"
      ],
      "properties": {
        "address1": {
          "type": "string",
          "example": "123 Some St.",
          "description": "Address 1"
        },
        "address2": {
          "type": "string",
          "example": "Suite 456",
          "description": "Address 2"
        },
        "city": {
          "type": "string",
          "example": "Supercity",
          "description": "City"
        },
        "state": {
          "type": "string",
          "example": "Goodstate",
          "description": "State code"
        },
        "postalCode": {
          "type": "string",
          "example": "12345",
          "description": "Postal Code"
        },
        "country": {
          "type": "string",
          "example": "US",
          "description": "ISO-3166 2-Letter Country Code."
        }
      },
      "description": "The address of the location."
    },
    "latitude": {
      "type": "string",
      "example": "12.935784",
      "description": "Latitude"
    },
    "longitude": {
      "type": "string",
      "example": "77.697332",
      "description": "Longitude"
    },
    "notes": {
      "type": "string",
      "example": "123 Some St. Denver Location",
      "description": "Notes"
    }
  }
}