API Documentation
Endpoints
- Auth
- Brands
- Tiers
- Rewards
- Customers
- Campaigns
- Behavior
- Coupons
- GETGet campaign
- GETGet campaigns
- POSTCreate a new campaign
- Transactions
- Push notifications
- Migrate
- Maintenance
Guides
Resources
Campaigns
Create a new campaign
Create a campaign
POST
/
campaigns
Copy
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "BEHAVIOR",
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"attributes": {
"trigger": "PURCHASE",
"privacy": "PRIVATE"
},
"status": "RUNNING",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000
}'
Copy
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "BEHAVIOR",
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"attributes": {
"trigger": "PURCHASE",
"privacy": "PRIVATE"
},
"status": "RUNNING",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
Campaign created
The response is of type object
.
Copy
curl --request POST \
--url https://app.masivo.ai/api/storefront/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "BEHAVIOR",
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"attributes": {
"trigger": "PURCHASE",
"privacy": "PRIVATE"
},
"status": "RUNNING",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000
}'
Copy
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "BEHAVIOR",
"rules": [
{
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"effects": [
{
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "POINTS",
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
},
"expiration_date": "12/months",
"amount": 1
}
]
}
],
"attributes": {
"trigger": "PURCHASE",
"privacy": "PRIVATE"
},
"status": "RUNNING",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"funded_by": "<string>",
"budget": 1000
}
}
Assistant
Responses are generated using AI and may contain mistakes.