---
title: "Withdraw a request"
method: POST
path: "/public/one-shot/requests/{requestId}/cancel"
tags: ["GVRN OneShot API"]
---

# Withdraw a request

`POST /public/one-shot/requests/{requestId}/cancel`

## Request

- Base URL: `https://docs.gvrn.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.gvrn.ai/public/one-shot/requests/{requestId}/cancel`
- Auth: API key in header `x-gvrn-public-api-key`

Withdraws a request GVRN has not started, and cancels its ticket. Once it is being worked on or is closed, GVRN cancels it rather than the partner.

## Path parameters

- `requestId` string, required

## Response `201`

Withdrawn

- OneShotRequestApiResponseDto
  - `id` string, required: The handle for reading or withdrawing it
  - `incorporationId` string, required
  - `companyId` string: The company the request is about
  - `kind` 'DOCUMENT' | 'COMPANY_DETAILS' | 'MEMBER_CHANGE' | 'SHARE_CAPITAL' | 'GOVERNANCE' | 'COMPLIANCE_FILING' | 'TAX' | 'ENTITY_CHANGE' | 'OTHER', required
  - `status` 'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CANCELLED', required: Derived from the CRM ticket behind the request
  - `subject` string, required
  - `details` string
  - `payload` object, required: Exactly what was sent, never what an operator has since edited
  - `attachmentCount` number, required: Files stored against the request's ticket
  - `createdAt` string, required: ISO 8601
  - `updatedAt` string, required: ISO 8601
  - `statusChangedAt` string, required: When the ticket last moved; for a RESOLVED request, when it closed
  - `cancelledAt` string: Set when the partner withdrew the request

## Other responses

- `404`: No such request for this key. One raised through another partner's key reads the same.
- `409`: Already being worked on, or closed

---

[API](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api.md) · [All operations](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gvrn/apis/gvrn-oneshot-api/revisions/31a2ef047b90?raw)