Skip to the page

Praecise Platform

Rivier/ Reference/ contacts

Mark a gift as handed over, by its code

post/loyalty/gifts/use

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Sdk: contacts.loyalty.useGift
Cli: contacts loyalty use gift

Request bodyapplication/json, required

codestringrequired
Pattern: ^[A-Za-z0-9-]{6,40}$.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/loyalty/gifts/use' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown