---
title: Update Zone Hold
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Zones](https://developers.cloudflare.com/api/go/resources/zones)

[Holds](https://developers.cloudflare.com/api/go/resources/zones/subresources/holds)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Update Zone Hold

client.Zones.Holds.Edit(ctx, params) (\*[ZoneHold](<https://developers.cloudflare.com/api/go/resources/zones#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)>), error)

PATCH/zones/{zone\_id}/hold

Update the `hold_after` and/or `include_subdomains` values on an existing zone hold. The hold is enabled if the `hold_after` date-time value is in the past. Existing zone holds can be removed from CDN-only zones by setting `hold_after` to `null`. Other zone hold updates cannot be made on CDN-only zones. Active holds are automatically disabled when a zone transitions to CDN-only mode.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Zone Write`

##### ParametersExpand Collapse

<details>

<summary>

params HoldEditParams

</summary>

ZoneID param.Field\[string]

Path param: Identifier.

maxLength32

<a href="#(resource)%20zones.holds%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

HoldAfter param.Field\[string]Optional

Body param: If <code>hold_after</code> is provided and future-dated, the hold will be temporarily disabled, then automatically re-enabled by the system at the time specified in this RFC3339-formatted timestamp. A past-dated <code>hold_after</code> value will have no effect on an existing, enabled hold. Providing an empty string will set its value to the current time. Providing <code>null</code> will disable the hold indefinitely.

<a href="#(resource)%20zones.holds%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20hold_after">Link to this property</a>

IncludeSubdomains param.Field\[bool]Optional

Body param: If <code>true</code>, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname ‘example.com’ and include\_subdomains=true will block ‘example.com’, ‘staging.example.com’, ‘api.staging.example.com’, etc.

<a href="#(resource)%20zones.holds%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20include_subdomains">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.holds%20%3E%20(method)%20edit%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type ZoneHold struct{…}

</summary>

Hold boolOptional

<a href="#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)%20%3E%20(property)%20hold">Link to this property</a>

HoldAfter stringOptional

<a href="#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)%20%3E%20(property)%20hold_after">Link to this property</a>

IncludeSubdomains stringOptional

<a href="#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)%20%3E%20(property)%20include_subdomains">Link to this property</a>

</details>

[Link to this property](<#(resource)%20zones.holds%20%3E%20(model)%20zone_hold%20%3E%20(schema)>)

### Update Zone Hold

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/zones"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  zoneHold, err := client.Zones.Holds.Edit(context.TODO(), zones.HoldEditParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zoneHold.Hold)
}
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36Z",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "hold": true,
    "hold_after": "2023-01-31T15:56:36Z",
    "include_subdomains": "include_subdomains"
  },
  "success": true
}
```