Updates the description for a rollback

APIs & SDKs

PATCHhttps://api.vercel.com/v1/projects/{projectId}/rollback/{deploymentId}/update-description

Updates the reason for a rollback, without changing the rollback status itself.

https://api.vercel.com/v1/projects/{projectId}/rollback/{deploymentId}/update-description

const response = await fetch('https://api.vercel.com/v1/projects/projectId/rollback/deploymentId/update-description', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "description": "string"
  }),
});

const data = await response.json();
console.log(data);

Response

{}

Path parameters

projectIdstringRequired

deploymentIdstringRequired

Body

application/json

descriptionstringOptional

The reason for the rollback

Response

200Success

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

422Error

Cross-link map: Updates the description for a rollback (/docs/rest-api/projects/updates-the-description-for-a-rollback)

From the Vercel docs graph (built 2026-10-07T05:48:34.144Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Update the rolling release settings for the project — PATCH /v1/projects/{idOrName}/rolling-release/config — Update \(or disable\) Rolling Releases for a project. When disabl
Point production traffic to a previous production deployment by ID — POST /v1/projects/{projectId}/rollback/{deploymentId} — Allows users to rollback to a deployment.
Update the active rolling release to the next stage for a project — POST /v1/projects/{idOrName}/rolling-release/approve-stage — Advance a rollout to the next stage. This is only needed wh
Delete rolling release configuration — DELETE /v1/projects/{idOrName}/rolling-release/config — Disable Rolling Releases for a project means that future deploym
request_rollback — Use request_rollback with Vercel MCP.

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/projects/{projectId}/rollback/{deploymentId}/update-description

const response = await fetch('https://api.vercel.com/v1/projects/projectId/rollback/deploymentId/update-description', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "description": "string"
  }),
});

const data = await response.json();
console.log(data);

Response

{}

OpenAPI Specification