- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- SMS Sender Identities
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Pages
- Components
- Website
- Website Domains
- Venue Info
- Landing Pages
- Landing Page Templates
- Articles
- Events
- Events Groups
- Job Postings
- Press Releases
- Tags
- Service Messages
- Content Prototypes
- ContentPrototype Model
- List Content Prototypes
- Show Content Prototype
- Create Content Prototype
- Update Content Prototype
- Destroy Content Prototype
- List Organization Content Prototypes
- Show Organization Content Prototype
- Create Organization Content Prototype
- Update Organization Content Prototype
- Destroy Organization Content Prototype
- Mixed Content
- Attachments
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
Introduction
Benefit model#
Example#
{
"id": 7,
"type": "generic",
"identifier": "program_1",
"audience_id": 421,
"name": { "en": "Name", "pl": "Nazwa" },
"description": { "en": "Description", "pl": "Opis" },
"conditions": { "en": "Conditions", "pl": "Wymogi" },
"created_at": "2023-11-27T15:46:25.513131Z",
"updated_at": "2023-11-27T15:46:25.513131Z",
"archived_at": null
}
Definition#
Key | Type | Static? | Required? | Description |
---|---|---|---|---|
id | integer | yes | yes | |
audience_id | integer | no | yes | Audience that defines conditions for benefit to be active for member |
type | enum: ['generic', 'parking'] | no | yes | |
identifier | string | no | yes | |
name | LocalizedContent | no | no | |
description | LocalizedContent | no | no | |
conditions | LocalizedContent | no | no | Natural language representation of audience conditions |
created_at | datetime | yes | yes | |
updated_at | datetime | yes | yes | |
archived_at | datetime | yes | yes |
Modified at 2024-05-06 15:15:27