---
title: "PATCH /v1/{+name}"
method: PATCH
path: "/v1/{+name}"
tags: ["projects"]
---

# PATCH /v1/{+name}

`PATCH /v1/{+name}`

Updates an existing snapshot by updating the fields specified in the update mask. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

## Path parameters

- `name` string, required

## Request body

- UpdateSnapshotRequest — Request for the UpdateSnapshot method.
  - `snapshot` Snapshot — A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
    - `name` string — Optional. The name of the snapshot.
    - `topic` string — Optional. The name of the topic from which this snapshot is retaining messages.
    - `expireTime` string, google-datetime — Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.
    - `labels` object — Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
  - `updateMask` string, google-fieldmask — Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/pubsub.md) · [All operations](https://skmtc.dev/google/apis/pubsub/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/pubsub/revisions/bf72396b5785/schema)