Skip to main content
POST
Add points to customer

Authorizations

X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Path Parameters

id
string
required

Unique identifier for this customer.

Body

Request parameters for adding points to a customer's loyalty balance.

amount
integer
required
Required range: x >= 1
reason
string
default:""
Maximum string length: 255

Response

Result of a points operation (add or reduce) with updated balance.

customer_id
string
required
read-only
operation
string
required
read-only
amount
integer
required
read-only
balance_before
integer
required
read-only
balance_after
integer
required
read-only
activity_id
string | null
required
read-only
created_at
string<date-time> | null
required
read-only