- 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
- Rules
- Event Types Schema
- Point Multipliers
- 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
Start Triggerer Rule
Pending
PUT
https://api.mpc.dev.placewise.com/v1/triggerer/rules/{rule_id}/start
API Permit:Triggerer:Api:Rules:Start
API Context:Loyalty Club
Authorizations:UserToken
Request
Path Params
rule_id
integer
required
Example:
1
Header Params
X-Client-Authorization
string
optional
Default:
{{API_TOKEN}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.mpc.dev.placewise.com/v1/triggerer/rules/1/start' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
name
object
required
value
string
required
translations
object
required
event_type
string
required
frequency
object
required
limit
integer
required
minimum
integer
required
rate
integer
required
limit
integer
required
minimum
integer
required
rate
integer
required
paused
boolean
required
data_conditions
object
required
operator
array[string]
required
value
string
required
value_type
array[string]
required
or_value_is_null
boolean
required
audience_id
integer
required
hook_delayed_by_seconds
integer
required
hook_on_checks_failure
boolean
required
excluded_sources
array[string]
required
daily_auto_trigger_at
string
required
hook_type
string
required
options
object
required
rewards_api
object
required
mesages_api
object
required
offers_api
object
required
slack
object
required
url
object
required
Example
{
"rule": {
"name": {
"value": "Use coupon from collection \"Valentines\"",
"translations": {
"pl": "Użycie kuponu z kolekcji \"Walentynki\""
}
},
"event_type": "string",
"frequency": {
"limit": 1,
"minimum": 1,
"rate": 1
},
"limit": 1,
"minimum": 1,
"rate": 1,
"paused": false,
"data_conditions": {
"operator": [
"EQUAL",
"GREATER",
"LOWER",
"EQUALS_OR_GREATER",
"EQUALS_OR_LOWER",
"IS_GIVEN",
"IS_NOT_GIVEN",
"NOT_EQUALS",
"IN",
"NOT_IN"
],
"value": "string",
"value_type": [
"STRING",
"NUMBER",
"BOOLEAN",
"ID",
"ARRAY_OF_STRINGS",
"ARRAY_OF_NUMBERS",
"ARRAY_OF_IDS"
],
"or_value_is_null": false
},
"audience_id": 1,
"hook_delayed_by_seconds": 100,
"hook_on_checks_failure": false,
"excluded_sources": [],
"daily_auto_trigger_at": "12:00",
"hook_type": "string",
"options": {
"rewards_api": {
"grant_points": 3,
"points_function": "if (eventData.amount > 100) {eventData.amount * 2} else if (eventData.amount > 50 && eventTime > Date.parse('2024-09-01')) {20} else {0}"
},
"mesages_api": {
"message_id": 1
},
"offers_api": {
"offer_id": 389123,
"offer_usable_for_seconds": 3600
},
"slack": {
"channel": "string",
"webhook_url": "https://url.com"
},
"url": {
"webhook_url": "https://url.com",
"webhook_secret": "string"
}
}
}
}Modified at 2025-04-08 11:45:23