- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Branding
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- 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
- Detect Receipt Fraud
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
Introduction
Link model#
Example
{
"slug": "about",
"name": "About",
"description": null,
"url": "/about",
"push_message_data": { "foo": "bar" },
"optional_params": [],
"system": false,
"global": true,
"enabled": true
}Definition#
| Key | Type | Optional? | Description |
|---|---|---|---|
| slug | string | no | Identifier or Link. Generated from name. |
| name | string | no | Must be unique |
| description | string | yes | |
| url | string | no | Must be unique |
| scheme | string | no | When present, link will be generated with this scheme |
| push_message_data | Object | yes | When present, it will be sent along push messages that contain this link |
| optional_params | string[] | yes | Contains information which link params are optional |
| system | boolean | no | Is this a system link? |
| global | boolean | no | Is this a global link? |
| enabled | boolean | no | Is this link enabled for specific LC? |