Delete a gift card

Removes a gift card from our system.

DELETE /gift-cards/{gift_card_id}

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

await sdk.GiftCards.DeleteAsync(giftCardId: "356d56e5-fe16-42ae-97ee-8d55d846ae2e");

// handle response

400

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Generic error",
  "details": []
}

This endpoint requires the gift-cards.write scope.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id · string

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

gift_card_id · string<uuid> · required

The ID of the gift card.

Example:

"356d56e5-fe16-42ae-97ee-8d55d846ae2e"

Response

204

Successful Response