Revoke Sharing

If a user has shared a gift card with another user, this API enables the user to revoke the sharing rights.

Path Parameters

uuid
Type: string
required

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

Headers

x-pch-digest
Type: string
required

The signature for the API call
Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
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
sharer_email
Type: string
required

Email address of the user whose gift card sharing rights will be revoked

Responses

text/plain
application/json
application/json

delete/api2/mobile/gift_cards/{uuid}/revoke

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

[
  "You are no longer sharing this card with <user>."
]