Transactional
Send transactional message
Send a one-off push notification to a user.
curl -X POST "https://api.flameup.ai/api/v1/workspaces/example_string/transactional/send" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"user_id": "example_string",
"template_id": "example_string",
"template": {
"title": "example_string",
"body": "example_string",
"data": {}
},
"data": {},
"platform": "ios"
}'
import requests
import json
url = "https://api.flameup.ai/api/v1/workspaces/example_string/transactional/send"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"user_id": "example_string",
"template_id": "example_string",
"template": {
"title": "example_string",
"body": "example_string",
"data": {}
},
"data": {},
"platform": "ios"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.flameup.ai/api/v1/workspaces/example_string/transactional/send", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"user_id": "example_string",
"template_id": "example_string",
"template": {
"title": "example_string",
"body": "example_string",
"data": {}
},
"data": {},
"platform": "ios"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"user_id": "example_string",
"template_id": "example_string",
"template": {
"title": "example_string",
"body": "example_string",
"data": {}
},
"data": {},
"platform": "ios"
}`)
req, err := http.NewRequest("POST", "https://api.flameup.ai/api/v1/workspaces/example_string/transactional/send", 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/transactional/send')
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_id": "example_string",
"template_id": "example_string",
"template": {
"title": "example_string",
"body": "example_string",
"data": {}
},
"data": {},
"platform": "ios"
}'
response = http.request(request)
puts response.body
{
"success": true,
"message_id": "example_string",
"delivered_to": [
"ios"
],
"devices_count": 10
}
POST
/workspaces/{workspaceId}/transactional/sendPOST
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
Content-Typestring
RequiredThe media type of the request body
Options: application/json
user_idstring
RequiredUser's external_id or Flameup person_id
template_idstring
ID of a pre-defined template
templateobject
Inline template (if no template_id)
dataobject
Variables for template personalization
platformstring
Target platform (defaults to all; web coming soon)
Options: ios, android, web, all
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
Body
application/json
user_idstring
RequiredUser's external_id or Flameup person_id
template_idstring
ID of a pre-defined template
templateobject
Inline template (if no template_id)
dataobject
Variables for template personalization
platformstring
Target platform (defaults to all; web coming soon)
Responses
successboolean
message_idstring
delivered_tostring[]
devices_countinteger
Was this page helpful?
Built with Documentation.AI
Last updated today