Create a program
Create a new program.
name. By default, on_unknown_participant is set to CREATE, which means participants are auto-created on their first event. Set it to REJECT if you need explicit registration before processing events.
Programs start as ACTIVE. You can suspend or archive them later via Update a program.
Authorizations
API key passed in the X-API-Key header.
Body
Program details
Program name
1 - 255"Q1 Sales Bonus"
Optional program description
1000"Quarterly sales incentive program for the sales team"
Default redemption behavior when capture is omitted. Defaults to INSTANT.
INSTANT, ASYNC "ASYNC"
How to handle events for unregistered participants. Defaults to CREATE when absent or null; an explicit "" or any non-enum value is rejected.
CREATE, REJECT "CREATE"
Optional program-specific bound between 60 seconds and one year. Accepts Go-style durations plus d/w; without a request or program bound, pending redemptions default to 90 days.
"24h"
Response
Program created
When the program was created
"2024-01-15T10:30:00Z"
Set when the program is archived
"2024-06-01T00:00:00Z"
Optional program description
"Quarterly sales incentive program"
Default redemption behavior when capture is omitted
INSTANT, ASYNC "INSTANT"
Program ID
"550e8400-e29b-41d4-a716-446655440000"
Program name
"Q1 Sales Bonus"
How events for unregistered participants are handled
"CREATE"
Optional program-specific bound between 60 seconds and one year. Without a request or program bound, pending redemptions default to 90 days.
"24h"
Target ledger entity ID. Present only when redemption_target_type is LEDGER_ENTITY.
"550e8400-e29b-41d4-a716-446655440002"
Where redeemed value is posted: SYSTEM_REDEMPTION, SYSTEM_BREAKAGE, or LEDGER_ENTITY
"SYSTEM_REDEMPTION"
Lifecycle state
"ACTIVE"
When the program was last modified
"2024-01-15T10:30:00Z"