---
title: "Records the usage of a QuickLink after the associated action has been performed."
method: POST
path: "/Sites/{siteId}/Quicklinks/{slug}/Consume"
tags: ["QuickLinks"]
---

# Records the usage of a QuickLink after the associated action has been performed.

`POST /Sites/{siteId}/Quicklinks/{slug}/Consume`

Call this endpoint after performing the QuickLink action to record the usage.
Include success=false and error details if the action failed.
This increments usage counters and marks tokens as used if successful.

## Path parameters

- `siteId` integer, required
- `slug` string, required

## Request body

- QPilotCoreModelsDtoQuickLinksConsumeRequestDto
  - `scheduledOrderId` integer, required
  - `customerId` integer, nullable
  - `token` string, nullable
  - `success` boolean, required
  - `errorCode` string, nullable
  - `errorMessage` string, nullable
  - `ipAddress` string, nullable
  - `userAgent` string, nullable
  - `executedAt` string, date-time, nullable

## Response `200`

Usage recorded successfully

- QPilotCoreModelsDtoQuickLinksConsumeResultDto
  - `recorded` boolean
  - `usageId` integer
  - `message` string, nullable
  - `currentUsageCount` integer
  - `usageRemaining` integer, nullable

## Other responses

- `404` — QuickLink not found
- `500` — Internal server error occurred

---

[API](https://skmtc.net/qpilot/apis/qpilot-api.md) · [All operations](https://skmtc.net/qpilot/apis/qpilot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qpilot/qpilot-api/revisions/b2f13a808fdd/schema)