8X8x8
Sites

Update site

Updates an existing site. Returns an Operation object that can be polled to track the update progress.

put/sites/{siteId}

Request

Path parameters

siteIdstring required
Example:0023OEZiR7qQ_EGb6xYjgg

Site identifier

Headers

X-Request-Idstring uuid

Optional request identifier for tracking

Request body

idstring nullable
namestring required
pbxNamestring required
locale'da-DK' | 'de-DE' | 'en-AU' | 'en-GB' | 'en-US' | 'es-ES' | 'fi-FI' | 'fr-BE' | 'fr-CA' | 'fr-CH' | 'fr-FR' | 'it-IT' | 'ja-JP' | 'nl-BE' | 'nl-NL' | 'no-NO' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'sv-SE' | 'zh-CN' required
timezonestring required
siteCodestring nullable
extensionLengthinteger nullable
defaultDialPlanCallingCountrystring nullable
defaultDialPlanRuleset'INTERNATIONAL' | 'DOMESTIC' | 'EMERGENCYONLY' nullable
defaultVoicemailZeroOutDestinationExtensionIdstring nullable
defaultVoicemailZeroOutDestinationExtensionNumberstring nullable

Example request

{
  "id": "0023OEZiR7qQ_EGb6xYjgg",
  "name": "SanJose-Onel",
  "locale": "en-US",
  "timezone": "Europe/London",
  "address": {
    "id": "b1c4944a-17a0-4b00-8d48-36001df07e22"
  },
  "siteCode": "1345",
  "extensionLength": 4,
  "emergencyNotifications": [
    {
      "type": "EMAIL",
      "values": [
        "john.doe@corp.com",
        "jane.doe@corp.com"
      ]
    }
  ],
  "callerIdSettings": {
    "mainNumber": "+12266280120",
    "setMainNumberAsCallerId": true,
    "displayName": "John Doe"
  },
  "defaultDialPlanCallingCountry": "NANP",
  "defaultDialPlanRuleset": "INTERNATIONAL",
  "defaultVoicemailZeroOutDestinationExtensionId": "0ejGzqYBSIiMloUrreLXmA",
  "defaultVoicemailZeroOutDestinationExtensionNumber": "1032"
}

Response

Site update operation initiated successfully

operationIdstring nullable

Unique identifier for the operation

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' nullable

Current status of the operation

customerIdstring nullable

Customer ID associated with the operation

resourceType'USER' | 'RING_GROUP' | 'SITE' nullable

Type of resource being operated on

resourceIdstring nullable

ID of the resource being operated on

operationType'CREATE' | 'UPDATE' | 'DELETE' nullable

Type of operation being performed

createdTimestring date-time nullable

Timestamp when the operation was created

completedTimestring date-time nullable

Timestamp when the operation completed

Example response

{
  "operationId": "op_123456789",
  "status": "PENDING",
  "customerId": "0012J00042NkZQIQA3",
  "resourceType": "SITE",
  "resourceId": "0023OEZiR7qQ_EGb6xYjgg",
  "operationType": "DELETE",
  "createdTime": "2025-01-01T01:02:03Z",
  "completedTime": "2025-01-01T01:05:03Z",
  "error": {
    "status": 404,
    "time": "2025-01-01T01:02:03Z",
    "title": "Site not found",
    "errors": [
      {
        "code": "VALIDATION_ERROR",
        "message": "Site not found"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.8x8.com/admin-provisioning/sites?pageSize=100&pageNumber=0"
    },
    "resource": {
      "href": "https://api.8x8.com/admin-provisioning/sites?pageSize=100&pageNumber=0"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.