POST/v1/document-requests/{id}/cancel

Cancel a document request

Withdraws one document request — we are no longer waiting on this paper. No body; id is the request. Only an OPEN request can move, so cancelling one already fulfilled or cancelled is a not-found. It drops off get_document-requests afterwards. Reach for post_document-requests_id_fulfil instead when the file actually arrived.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "cancelledAt": "string",
    "documentType": "string",
    "dueAt": "string",
    "fulfilledAt": "string",
    "fulfilledBy": 1,
    "fulfilledFileId": "",
    "id": "",
    "note": "string",
    "periods": [
      {
        "label": "string",
        "periodEnd": "string",
        "periodStart": "string"
      }
    ],
    "requestedAt": "string",
    "requestedBy": 1,
    "rowId": "",
    "sentAt": "string",
    "sentMedium": "string",
    "sentMessageId": 1,
    "sentTo": "string",
    "status": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired