arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/find_promo_code

Find Promo Code

Used to get both gift cards balances and promo details. Only authorized accounts may use this endpoint.

Body

Name Description Type Additional information
code Promo code or gift card code text

Required

email_address Optional - Should include if it the coupon is assigned to a specific email account. text None.
account_key Optional - User account associated with the request. Note, this will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and the request will based upon the user's api credentials. Leave as null if not authorized to use this parameter. text None.

Example JSON Body

application/json, text/json

{
  "code": "sample string 1",
  "email_address": "sample string 2",
  "account_key": "sample string 3"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/find_promo_code' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "code": "sample string 1",
  "email_address": "sample string 2",
  "account_key": "sample string 3"
}'