---
title: "Revoke an unused gift link"
method: POST
path: "/sends/{id}/gift-link/revoke"
tags: ["Gift links"]
---

# Revoke an unused gift link

`POST /sends/{id}/gift-link/revoke`

## Request

- Base URL: `https://gtmswag.com/api/v1`
- URL: `https://gtmswag.com/api/v1/sends/{id}/gift-link/revoke`
- Auth: HTTP bearer

The link stops working at once. The gift stays reserved (it can be regifted); revoking does not refund it. Redeemed links cannot be revoked. Repeating the call on a revoked link returns it unchanged.

## Path parameters

- `id` string, required

## Request body

- object
  - `generation` integer, required: The gift link's current generation.

## Response `200`

Success: `{"data": GiftLink}`.

- GiftLinkResponse: The success body: `{"data": GiftLink}`.
  - `data` GiftLink, required: A private claim link: its state, value and the `generation` and `messageVersion` edits need.
    - `sendId` string, required
    - `recipient` Recipient, required
      - `recipientId` string, required
      - `name` string, required
      - `email` string, required
      - `company` string, required
      - `sourceSystem` string
      - `externalId` string
      - `profileUrl` string
      - `importId` string
      - `importRowId` string
      - `addressMode` 'known' | 'confirm'
    - `generation` integer, required
    - `messageVersion` integer, required
    - `state` 'unclaimed' | 'redeemed' | 'revoked' | 'expired' | 'declined' | 'cancelled', required
    - `canRegift` boolean, required
    - `valueCents` integer, required

## Other responses

- `400`: Bad request: `VALIDATION_ERROR`, `INVALID_JSON`. Each example says when.
- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `404`: Not found: `NOT_FOUND`. Each example says when.
- `409`: Conflict: `GIFT_LINK_CONFLICT`. Each example says when.
- `413`: Request too large: `INVALID_REQUEST`. the body exceeds 1 MiB.
- `415`: Unsupported media type: `INVALID_REQUEST`. a write with a body that is not `Content-Type: application/json` (a key request with no body needs no Content-Type).
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)
