Skip to main content
POST
/
api
/
ext
/
v1
/
people
/
withdraw
Withdraw Credits/Points/Gifts
curl --request POST \
  --url https://staging-api.covver.io/api/ext/v1/people/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collectionId": "<string>",
  "emails": [
    "<string>"
  ],
  "amount": 123,
  "companyId": "<string>"
}
'
{
  "numAffectedPeople": 123
}
The type of reward is determined by the collection - whether it’s a gift store, or a credits store
If you withdraw more credits/gifts than a person has, their balance will be 0
If you want to withdraw all credits/gifts, just pass a very high amount

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
collectionId
string
required
​
emails
string[]
required
​
amount
number
required
​
companyId
string

Response

Default Response

​
numAffectedPeople
number
required