Add Manual Flow Enrollment
curl --request POST \
--url https://api.example.com/api/public/tools/add_manual_flow_enrollment \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"manualEnrollment": {
"company": {
"domain": "<string>",
"linkedinUrl": "<string>",
"linkedinId": 123
},
"prospect": {
"firstName": "<string>",
"lastName": "<string>",
"linkedinUrl": "<string>",
"email": "<string>",
"phone": "<string>"
},
"options": {
"ignoreExclusionCheck": true,
"priority": 123
},
"firstMessage": {
"subject": "<string>",
"content": "<string>"
}
},
"enrollmentMode": null,
"includeWorkspaceRefresh": true
}
'import requests
url = "https://api.example.com/api/public/tools/add_manual_flow_enrollment"
payload = {
"flowPlanId": "<string>",
"manualEnrollment": {
"company": {
"domain": "<string>",
"linkedinUrl": "<string>",
"linkedinId": 123
},
"prospect": {
"firstName": "<string>",
"lastName": "<string>",
"linkedinUrl": "<string>",
"email": "<string>",
"phone": "<string>"
},
"options": {
"ignoreExclusionCheck": True,
"priority": 123
},
"firstMessage": {
"subject": "<string>",
"content": "<string>"
}
},
"enrollmentMode": None,
"includeWorkspaceRefresh": 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({
flowPlanId: '<string>',
manualEnrollment: {
company: {domain: '<string>', linkedinUrl: '<string>', linkedinId: 123},
prospect: {
firstName: '<string>',
lastName: '<string>',
linkedinUrl: '<string>',
email: '<string>',
phone: '<string>'
},
options: {ignoreExclusionCheck: true, priority: 123},
firstMessage: {subject: '<string>', content: '<string>'}
},
enrollmentMode: null,
includeWorkspaceRefresh: true
})
};
fetch('https://api.example.com/api/public/tools/add_manual_flow_enrollment', 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://api.example.com/api/public/tools/add_manual_flow_enrollment",
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([
'flowPlanId' => '<string>',
'manualEnrollment' => [
'company' => [
'domain' => '<string>',
'linkedinUrl' => '<string>',
'linkedinId' => 123
],
'prospect' => [
'firstName' => '<string>',
'lastName' => '<string>',
'linkedinUrl' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'options' => [
'ignoreExclusionCheck' => true,
'priority' => 123
],
'firstMessage' => [
'subject' => '<string>',
'content' => '<string>'
]
],
'enrollmentMode' => null,
'includeWorkspaceRefresh' => 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://api.example.com/api/public/tools/add_manual_flow_enrollment"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\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://api.example.com/api/public/tools/add_manual_flow_enrollment")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/tools/add_manual_flow_enrollment")
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 \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}FirstTouch tools
Add Manual Flow Enrollment
Add one contact/prospect to an existing flow.
Usage notes
- For a plain request such as ‘Add contact X to flow Y’, omit enrollmentMode so the flow plan’s processing strategy determines the outcome; a draft flow adds the contact to Awaiting.
- Set enrollmentMode=enroll only when the user explicitly asks to enroll or start the contact immediately; the flow must be published.
- Set enrollmentMode=manual only when the user explicitly asks for manual enrollment or to add the contact to Awaiting without starting it.
- The flow plan is specified only by top-level flowPlanId.
POST
/
api
/
public
/
tools
/
add_manual_flow_enrollment
Add Manual Flow Enrollment
curl --request POST \
--url https://api.example.com/api/public/tools/add_manual_flow_enrollment \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"manualEnrollment": {
"company": {
"domain": "<string>",
"linkedinUrl": "<string>",
"linkedinId": 123
},
"prospect": {
"firstName": "<string>",
"lastName": "<string>",
"linkedinUrl": "<string>",
"email": "<string>",
"phone": "<string>"
},
"options": {
"ignoreExclusionCheck": true,
"priority": 123
},
"firstMessage": {
"subject": "<string>",
"content": "<string>"
}
},
"enrollmentMode": null,
"includeWorkspaceRefresh": true
}
'import requests
url = "https://api.example.com/api/public/tools/add_manual_flow_enrollment"
payload = {
"flowPlanId": "<string>",
"manualEnrollment": {
"company": {
"domain": "<string>",
"linkedinUrl": "<string>",
"linkedinId": 123
},
"prospect": {
"firstName": "<string>",
"lastName": "<string>",
"linkedinUrl": "<string>",
"email": "<string>",
"phone": "<string>"
},
"options": {
"ignoreExclusionCheck": True,
"priority": 123
},
"firstMessage": {
"subject": "<string>",
"content": "<string>"
}
},
"enrollmentMode": None,
"includeWorkspaceRefresh": 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({
flowPlanId: '<string>',
manualEnrollment: {
company: {domain: '<string>', linkedinUrl: '<string>', linkedinId: 123},
prospect: {
firstName: '<string>',
lastName: '<string>',
linkedinUrl: '<string>',
email: '<string>',
phone: '<string>'
},
options: {ignoreExclusionCheck: true, priority: 123},
firstMessage: {subject: '<string>', content: '<string>'}
},
enrollmentMode: null,
includeWorkspaceRefresh: true
})
};
fetch('https://api.example.com/api/public/tools/add_manual_flow_enrollment', 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://api.example.com/api/public/tools/add_manual_flow_enrollment",
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([
'flowPlanId' => '<string>',
'manualEnrollment' => [
'company' => [
'domain' => '<string>',
'linkedinUrl' => '<string>',
'linkedinId' => 123
],
'prospect' => [
'firstName' => '<string>',
'lastName' => '<string>',
'linkedinUrl' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'options' => [
'ignoreExclusionCheck' => true,
'priority' => 123
],
'firstMessage' => [
'subject' => '<string>',
'content' => '<string>'
]
],
'enrollmentMode' => null,
'includeWorkspaceRefresh' => 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://api.example.com/api/public/tools/add_manual_flow_enrollment"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\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://api.example.com/api/public/tools/add_manual_flow_enrollment")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/tools/add_manual_flow_enrollment")
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 \"flowPlanId\": \"<string>\",\n \"manualEnrollment\": {\n \"company\": {\n \"domain\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"linkedinId\": 123\n },\n \"prospect\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"options\": {\n \"ignoreExclusionCheck\": true,\n \"priority\": 123\n },\n \"firstMessage\": {\n \"subject\": \"<string>\",\n \"content\": \"<string>\"\n }\n },\n \"enrollmentMode\": null,\n \"includeWorkspaceRefresh\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}Authorizations
Body
application/json
Existing flow plan id. Use the exact flowPlanId returned by create_flow_plan, list_flow_plans, or get_flow_workspace; do not use the read-only MCP Dynamic Actions flowPlanId here.
Contact and optional first-email details. The flow plan is set only through the top-level flowPlanId. Omit or pass null for options to use normal exclusion checks and priority 0.
Show child attributes
Show child attributes
Optional override of the flow plan's enrollment behavior.
- For a plain request such as 'Add contact X to flow Y', do not set this field.
- A draft flow always adds an omitted mode to Awaiting.
- Set enroll only when the user explicitly asks to enroll or start the contact immediately; this requires a published flow.
- Set manual only when the user explicitly asks for manual enrollment or to add the contact to Awaiting without starting it.
Available options:
manual, enroll, null Include refreshed counts and first awaiting page in the response.
Response
Tool result.

