Skip to main content
POST
/
v1
/
pvt
/
Rewards
/
updatemetadata
cURL
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Rewards/updatemetadata \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalKey": "<string>",
  "Metadatas": [
    {
      "Name": "<string>",
      "Value": "<string>"
    }
  ]
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "RewardId": 123,
    "Point": {
      "PointId": 123,
      "Quantity": 123,
      "Metadatas": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ]
    },
    "ExternalCode": "<string>",
    "OriginalKey": "<string>",
    "Coupon": {
      "CouponCode": "<string>",
      "CouponType": 0,
      "CouponValue": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z"
    }
  },
  "HasError": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json
OriginalKey
string

The same OriginalKey used on reward redeeming

Metadatas
object[]

A list of name-value that will be added to the point metadatas for this reward.

Response

200 - application/json
ErrorMessage
string | null

Error message or description

ErrorCode
integer<int32> | null

Optional error code, if available

Result
object
HasError
boolean

If true the request had an error.