Skip to main content
POST
Grant entry passes 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
Example:

"CZK"

price
number
required
Required range: x >= 0
passGroupId
integer | null

Target pass group. Omit it or send null for the studio default group. A group belonging to another studio, or an unknown ID, is rejected with 400.

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

Response

The client's new entry balance in the target group.

statusCode
integer
Example:

200

message
string
Example:

"Success"

data
object