Create Social Engagement Signal
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"request": {
"name": "<string>",
"profileUrls": [
"<string>"
],
"loadHistory": true
}
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal"
payload = { "request": {
"name": "<string>",
"profileUrls": ["<string>"],
"loadHistory": True
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({request: {name: '<string>', profileUrls: ['<string>'], loadHistory: true}})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'request' => [
'name' => '<string>',
'profileUrls' => [
'<string>'
],
'loadHistory' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal"
payload := strings.NewReader("{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"summary": "<string>",
"signalId": "<string>",
"flowPlanId": "<string>",
"signal": {
"id": "<string>",
"name": "<string>",
"engagementType": "<string>",
"isSystem": true,
"isEnabled": true,
"isUnlocked": true,
"flowPlanId": "<string>",
"flowPlan": {
"id": "<string>",
"name": "<string>",
"isDraft": true
}
},
"warnings": [
"<string>"
],
"nextSteps": [
"<string>"
],
"uiLinks": [
{
"label": "<string>",
"url": "<string>",
"reason": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Social Engagement
Create Social Engagement Signal
Requires the admin team role or global admin access. Check get_current_user.toolAccess before calling.
Read get_guide with topic=social_engagement before using this tool; reuse it if already read for the current request.
Detailed usage guidance
- Creates a named Social Engagement signal, its own draft Flow Plan, and zero or more monitored LinkedIn profiles/company pages.
- Requires team admin access and paid or trial access.
- The signal’s tracking mode applies to all its profiles and cannot be changed.
- Collection starts asynchronously when eligible and can consume FirstTouch credits, even while the linked flow is draft; loadHistory can also consume credits.
- Each seat allows five nondeleted monitors across the team, including paused monitors.
- The generated flow starts in draft with manual enrollment; creation does not publish it, enroll contacts, or send outreach.
- Return signalId and flowPlanId for subsequent monitoring and flow configuration.
- This operation is not idempotent; inspect existing signals before retrying an uncertain result.
POST
/
api
/
public
/
tools
/
create_social_engagement_signal
Create Social Engagement Signal
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"request": {
"name": "<string>",
"profileUrls": [
"<string>"
],
"loadHistory": true
}
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal"
payload = { "request": {
"name": "<string>",
"profileUrls": ["<string>"],
"loadHistory": True
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({request: {name: '<string>', profileUrls: ['<string>'], loadHistory: true}})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'request' => [
'name' => '<string>',
'profileUrls' => [
'<string>'
],
'loadHistory' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal"
payload := strings.NewReader("{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/create_social_engagement_signal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request\": {\n \"name\": \"<string>\",\n \"profileUrls\": [\n \"<string>\"\n ],\n \"loadHistory\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"summary": "<string>",
"signalId": "<string>",
"flowPlanId": "<string>",
"signal": {
"id": "<string>",
"name": "<string>",
"engagementType": "<string>",
"isSystem": true,
"isEnabled": true,
"isUnlocked": true,
"flowPlanId": "<string>",
"flowPlan": {
"id": "<string>",
"name": "<string>",
"isDraft": true
}
},
"warnings": [
"<string>"
],
"nextSteps": [
"<string>"
],
"uiLinks": [
{
"label": "<string>",
"url": "<string>",
"reason": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Body
application/json