---
title: "Update site"
method: PUT
path: "/sites/{siteId}"
tags: ["Sites"]
---

# Update site

`PUT /sites/{siteId}`

## Request

- Base URL: `https://api.8x8.com/admin-provisioning`
- URL: `https://api.8x8.com/admin-provisioning/sites/{siteId}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/docs/sites/:siteId/put.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `siteId` string, required

## Headers

- `X-Request-Id` string, uuid

## Request body

- Site
  - `id` string, nullable
  - `name` string, required
  - `pbxName` string, 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
  - `timezone` string, required
  - `address` SiteAddress, required
    - `id` string, nullable
  - `siteCode` string, nullable
  - `extensionLength` integer, nullable
  - `emergencyNotifications` EmergencyNotification[], nullable
    - `type` 'EMAIL', nullable
    - `values` string[], nullable
  - `callerIdSettings` CallerIdSettings
    - `mainNumber` string, nullable
    - `setMainNumberAsCallerId` boolean, nullable
    - `shareMainNumberAsCallerId` boolean, nullable
    - `displayName` string, nullable
  - `defaultDialPlanCallingCountry` string, nullable
  - `defaultDialPlanRuleset` 'INTERNATIONAL' | 'DOMESTIC' | 'EMERGENCYONLY', nullable
  - `defaultVoicemailZeroOutDestinationExtensionId` string, nullable
  - `defaultVoicemailZeroOutDestinationExtensionNumber` string, nullable

## Response `202`

Site update operation initiated successfully

- Operation
  - `operationId` string, nullable: Unique identifier for the operation
  - `status` 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'UNKNOWN', nullable: Current status of the operation
  - `customerId` string, nullable: Customer ID associated with the operation
  - `resourceType` 'USER' | 'RING_GROUP' | 'SITE', nullable: Type of resource being operated on
  - `resourceId` string, nullable: ID of the resource being operated on
  - `operationType` 'CREATE' | 'UPDATE' | 'DELETE', nullable: Type of operation being performed
  - `createdTime` string, date-time, nullable: Timestamp when the operation was created
  - `completedTime` string, date-time, nullable: Timestamp when the operation completed
  - `error` ErrorResponse
    - `status` integer, nullable: HTTP status code
    - `instance` string, nullable: URI reference that identifies the specific occurrence of the problem
    - `time` string, date-time, nullable: Timestamp when the error occurred
    - `title` string, nullable: Short, human-readable summary of the problem
    - `detail` string, nullable: Human-readable explanation specific to this occurrence
    - `errors` Error[], nullable
      - `field` string, nullable: Field name related to the error
      - `code` 'UNKNOWN' | 'VALIDATION_ERROR' | 'FORBIDDEN' | 'CONFLICTING_QUERY_PARAMETER' | 'SERVICE_UNAVAILABLE' | 'NOT_FOUND' | 'BAD_REQUEST' | 'REQUEST_TIMEOUT' | 'TOO_MANY_REQUESTS' | 'CONFLICT', nullable: Error code identifying the type of error
      - `message` string, nullable: Detailed error message
  - `_links` OperationLinks
    - `self` Link
      - `href` string, nullable: URL for the link
    - `resource` Link
      - `href` string, nullable: URL for the link

## Other responses

- `400`: Bad Request - Invalid site data
- `403`: Forbidden - Access denied to this resource
- `404`: Not Found - Site does not exist
- `408`: Request Timeout - Downstream service timeout
- `429`: Too Many Requests - Rate limit exceeded
- `500`: Internal Server Error - Unexpected error occurred
- `503`: Service Unavailable - Service unavailable due to connectivity or network issues

---

[API](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api.md) - [All operations](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/8x8/apis/8x8-administration-site-management-api/revisions/8e00e01e46e0?raw)