Lead Follow-ups
Create lead follow-up
Schedules a new follow-up reminder for a lead. Requires crm:write scope.
POST
/
lead-followups
Create Lead Follow-up
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"lead_id": "lead_890ef12a",
"title": "Contract Review Call",
"due_date": "2026-10-30T15:00:00.000Z",
"notes": "Discuss volume discount and renewal terms.",
"reminder_at": "2026-10-30T14:45:00.000Z",
"assigned_to": "user_sarah"
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups"
payload = {
"lead_id": "lead_890ef12a",
"title": "Contract Review Call",
"due_date": "2026-10-30T15:00:00.000Z",
"notes": "Discuss volume discount and renewal terms.",
"reminder_at": "2026-10-30T14:45:00.000Z",
"assigned_to": "user_sarah"
}
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({
lead_id: 'lead_890ef12a',
title: 'Contract Review Call',
due_date: '2026-10-30T15:00:00.000Z',
notes: 'Discuss volume discount and renewal terms.',
reminder_at: '2026-10-30T14:45:00.000Z',
assigned_to: 'user_sarah'
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups', 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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups",
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([
'lead_id' => 'lead_890ef12a',
'title' => 'Contract Review Call',
'due_date' => '2026-10-30T15:00:00.000Z',
'notes' => 'Discuss volume discount and renewal terms.',
'reminder_at' => '2026-10-30T14:45:00.000Z',
'assigned_to' => 'user_sarah'
]),
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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups"
payload := strings.NewReader("{\n \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups")
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 \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "fol_7721a9",
"entity_id": "lead_890ef12a",
"entity_type": "lead",
"title": "Contract Review Call",
"notes": "Review updated pricing terms with CFO",
"due_date": "2026-10-30T15:00:00.000Z",
"reminder_at": "2026-10-30T14:45:00.000Z",
"status": "pending",
"assigned_to": "user_sarah",
"created_at": "2026-10-26T10:00:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}{
"success": false,
"data": null,
"error": {
"message": "Resource not found"
}
}Schedules a new follow-up reminder or action task associated with a lead.
Request attributes
lead_id(string, required): Identifier of the target lead.title(string, required): Short summary of the scheduled task.due_date(string, required): ISO 8601 timestamp for when the task is due.reminder_at(string, optional): ISO 8601 timestamp for notification alert.notes(string, optional): Detailed guidance or meeting preparation notes.assigned_to(string, optional): Team member responsible for the follow-up.
Required permissions
Requires an API key with thecrm:write scope.Authorizations
Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.
Body
application/json
Example:
"lead_890ef12a"
Example:
"Contract Review Call"
Example:
"2026-10-30T15:00:00.000Z"
Example:
"Discuss volume discount and renewal terms."
Example:
"2026-10-30T14:45:00.000Z"
Example:
"user_sarah"
⌘I
Create Lead Follow-up
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"lead_id": "lead_890ef12a",
"title": "Contract Review Call",
"due_date": "2026-10-30T15:00:00.000Z",
"notes": "Discuss volume discount and renewal terms.",
"reminder_at": "2026-10-30T14:45:00.000Z",
"assigned_to": "user_sarah"
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups"
payload = {
"lead_id": "lead_890ef12a",
"title": "Contract Review Call",
"due_date": "2026-10-30T15:00:00.000Z",
"notes": "Discuss volume discount and renewal terms.",
"reminder_at": "2026-10-30T14:45:00.000Z",
"assigned_to": "user_sarah"
}
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({
lead_id: 'lead_890ef12a',
title: 'Contract Review Call',
due_date: '2026-10-30T15:00:00.000Z',
notes: 'Discuss volume discount and renewal terms.',
reminder_at: '2026-10-30T14:45:00.000Z',
assigned_to: 'user_sarah'
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups', 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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups",
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([
'lead_id' => 'lead_890ef12a',
'title' => 'Contract Review Call',
'due_date' => '2026-10-30T15:00:00.000Z',
'notes' => 'Discuss volume discount and renewal terms.',
'reminder_at' => '2026-10-30T14:45:00.000Z',
'assigned_to' => 'user_sarah'
]),
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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups"
payload := strings.NewReader("{\n \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\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://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/lead-followups")
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 \"lead_id\": \"lead_890ef12a\",\n \"title\": \"Contract Review Call\",\n \"due_date\": \"2026-10-30T15:00:00.000Z\",\n \"notes\": \"Discuss volume discount and renewal terms.\",\n \"reminder_at\": \"2026-10-30T14:45:00.000Z\",\n \"assigned_to\": \"user_sarah\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "fol_7721a9",
"entity_id": "lead_890ef12a",
"entity_type": "lead",
"title": "Contract Review Call",
"notes": "Review updated pricing terms with CFO",
"due_date": "2026-10-30T15:00:00.000Z",
"reminder_at": "2026-10-30T14:45:00.000Z",
"status": "pending",
"assigned_to": "user_sarah",
"created_at": "2026-10-26T10:00:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}{
"success": false,
"data": null,
"error": {
"message": "Resource not found"
}
}