Facebook Lead Ads
Create Facebook Lead Ads automation
Subscribes a page to lead-form webhooks and configures the reply sent to new leads. Use facebookLeadAds.listPages/facebookLeadAds.listForms first to resolve valid page/form ids.
POST
/
v1
/
facebook-lead-ads
Create Facebook Lead Ads automation
curl --request POST \
--url https://app.chatbotx.io/api/v1/facebook-lead-ads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pageId": "<string>",
"formId": "<string>",
"pageName": "<string>",
"formName": "<string>",
"fieldMapping": [],
"flowId": ""
}
'import requests
url = "https://app.chatbotx.io/api/v1/facebook-lead-ads"
payload = {
"name": "<string>",
"pageId": "<string>",
"formId": "<string>",
"pageName": "<string>",
"formName": "<string>",
"fieldMapping": [],
"flowId": ""
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
pageId: '<string>',
formId: '<string>',
pageName: '<string>',
formName: '<string>',
fieldMapping: [],
flowId: ''
})
};
fetch('https://app.chatbotx.io/api/v1/facebook-lead-ads', 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://app.chatbotx.io/api/v1/facebook-lead-ads",
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([
'name' => '<string>',
'pageId' => '<string>',
'formId' => '<string>',
'pageName' => '<string>',
'formName' => '<string>',
'fieldMapping' => [
],
'flowId' => ''
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.chatbotx.io/api/v1/facebook-lead-ads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.chatbotx.io/api/v1/facebook-lead-ads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/facebook-lead-ads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"pageId": "<string>",
"pageName": "<string>",
"formId": "<string>",
"formName": "<string>",
"fieldMapping": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"target": "<string>"
}
],
"flowId": "<string>",
"leadsHandledCount": -1
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Automation name.
Required string length:
1 - 100Facebook page id. Get it from facebookLeadAds.listPages.
Minimum string length:
1Lead form id, or "*" for every form on the page. Get it from facebookLeadAds.listForms.
Minimum string length:
1Display name of the page.
Display name of the lead form.
Mappings from lead form fields to contact/custom fields.
Show child attributes
Show child attributes
Flow id to start when a new lead arrives, or null to send no flow.
Response
OK
Show child attributes
Show child attributes
Required range:
-2147483648 <= x <= 2147483647Was this page helpful?
⌘I
Create Facebook Lead Ads automation
curl --request POST \
--url https://app.chatbotx.io/api/v1/facebook-lead-ads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"pageId": "<string>",
"formId": "<string>",
"pageName": "<string>",
"formName": "<string>",
"fieldMapping": [],
"flowId": ""
}
'import requests
url = "https://app.chatbotx.io/api/v1/facebook-lead-ads"
payload = {
"name": "<string>",
"pageId": "<string>",
"formId": "<string>",
"pageName": "<string>",
"formName": "<string>",
"fieldMapping": [],
"flowId": ""
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
pageId: '<string>',
formId: '<string>',
pageName: '<string>',
formName: '<string>',
fieldMapping: [],
flowId: ''
})
};
fetch('https://app.chatbotx.io/api/v1/facebook-lead-ads', 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://app.chatbotx.io/api/v1/facebook-lead-ads",
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([
'name' => '<string>',
'pageId' => '<string>',
'formId' => '<string>',
'pageName' => '<string>',
'formName' => '<string>',
'fieldMapping' => [
],
'flowId' => ''
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.chatbotx.io/api/v1/facebook-lead-ads"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.chatbotx.io/api/v1/facebook-lead-ads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/facebook-lead-ads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"pageId\": \"<string>\",\n \"formId\": \"<string>\",\n \"pageName\": \"<string>\",\n \"formName\": \"<string>\",\n \"fieldMapping\": [],\n \"flowId\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"pageId": "<string>",
"pageName": "<string>",
"formId": "<string>",
"formName": "<string>",
"fieldMapping": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>",
"target": "<string>"
}
],
"flowId": "<string>",
"leadsHandledCount": -1
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}