Delete Gift Card

Removes a gift card from a user's app so that it will not be returned in API responses under the gift card list for a user, but does not delete it from the Punchh system

Note: It will be visible under the user profile in the Punchh platform as "card removed". To delete it from an existing user account in order to add it again for the same user or another user, please file a support ticket.

Path Parameters

uuid
Type: string
required

Unique ID of the gift card issued by and maintained in the Punchh system

Headers

Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
x-pch-digest
Type: string
required

The signature for the API call
Accept-Language
Type: string

Preferred language
Content-Type
Type: string
required

Set this header to application/json.
User-Agent
Type: string
required

Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

Body

application/json

client
Type: string
required

OAuth client ID provided by the business

Responses

application/json

delete/api2/mobile/gift_cards/{uuid}

curl 'https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/gift_cards/{uuid}' \
  --request DELETE \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'Accept-Language: en' \
  --header 'Content-Type: application/json' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --data '{
  "client": "CLIENT_GOES_HERE"
}'

Show Schema

{ 
  "Gift Card successfully deleted."
}