---
title: "Verb Resource"
description: "Outcome-focused description in one sentence."
openapi: METHOD /v1/path
---
{/* Custom CSS mirrors this beside the generated endpoint heading. */}
<span data-api-safety-label="read-only"><Badge color="gray" size="sm" shape="pill">Read only</Badge></span>
Explain what the operation accomplishes and the resource lifecycle state it expects.
## Before you begin
- Required resource state, permissions, configuration, and IDs.
- Link to the operation that produces each prerequisite.
## Minimal request
Show the smallest valid body or query and explain where each placeholder comes from.
## Verify the result
State the status code, important response fields, follow-up GET, dashboard location, or webhook that proves success.
## Errors and recovery
List operation-specific errors, the likely cause, and the exact remediation. State whether retrying can duplicate work.
## Related endpoints
Link to the previous and next lifecycle operations.
