Skip to main content
POST
Grant credits to a client

Authorizations

Authorization
string
header
required

Your secret API key (zen_live_…), sent as Authorization: Bearer <key>. Backend-to-backend only — never expose it in a browser. See Authentication.

Path Parameters

clientId
integer
required

The client's numeric id, taken from the id field of GET /v1/clients. This is not the opaque _id. Malformed values and numeric prefixes return 400.

Required range: x >= 1
Example:

123

Body

application/json
customEntryCount
object
required

How many credits or entries to grant, and for how long.

currency
string
required

Currency code recorded on the grant. Send the studio's configured currency, typically an ISO 4217 code such as CZK, EUR, or USD. The value is stored as sent and its format is not validated, so a typo is recorded rather than rejected. Send price: 0 for a gift.

Example:

"CZK"

price
number
required

What the client paid. Send 0 for a gift or a reward.

Required range: x >= 0
sendEmail
boolean
default:true

Set to false to grant silently, with no notification email.

Response

The client's new credit balance.

statusCode
integer
Example:

200

message
string
Example:

"Success"

data
object