Campaigns
Trigger campaign
Manually trigger a campaign for specific users.
curl -X POST "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"user_ids": [
"example_string"
],
"filters": {},
"data": {}
}'
import requests
import json
url = "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"user_ids": [
"example_string"
],
"filters": {},
"data": {}
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"user_ids": [
"example_string"
],
"filters": {},
"data": {}
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"user_ids": [
"example_string"
],
"filters": {},
"data": {}
}`)
req, err := http.NewRequest("POST", "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.flameup.ai/api/v1/workspaces/example_string/campaigns/example_string/trigger')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"user_ids": [
"example_string"
],
"filters": {},
"data": {}
}'
response = http.request(request)
puts response.body
{
"success": true,
"recipients_count": 10
}
POST
/workspaces/{workspaceId}/campaigns/{campaignId}/triggerPOST
Security Scheme
Bearer Token
Bearer Tokenstring
RequiredYour Flameup API key (passed as Bearer token)
Your Flameup API key (passed as Bearer token)
path
workspaceIdstring
RequiredWorkspace ID
path
campaignIdstring
RequiredCampaign ID
Content-Typestring
RequiredThe media type of the request body
Options: application/json
Request Preview
Response
Response will appear here after sending the request
Authentication
BearerAuth
header
Authorizationstring
RequiredBearer token. Your Flameup API key (passed as Bearer token)
Path Parameters
workspaceIdstring
RequiredWorkspace ID
campaignIdstring
RequiredCampaign ID
Responses
successboolean
recipients_countinteger
Was this page helpful?
Built with Documentation.AI
Last updated today