Add Audience Member (Webhook)

curl --request POST \
  --url https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "5551234567",
  "email": "jane@example.com",
  "custom_fields": {
    "service_type": "HVAC",
    "source": "website"
  }
}
'

import requests

url = "https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/"

payload = {
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "5551234567",
    "email": "jane@example.com",
    "custom_fields": {
        "service_type": "HVAC",
        "source": "website"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: 'Jane',
    last_name: 'Doe',
    phone: '5551234567',
    email: 'jane@example.com',
    custom_fields: {service_type: 'HVAC', source: 'website'}
  })
};

fetch('https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/', 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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/",
  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([
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'phone' => '5551234567',
    'email' => 'jane@example.com',
    'custom_fields' => [
        'service_type' => 'HVAC',
        'source' => 'website'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/"

	payload := strings.NewReader("{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "custom_fields": {}
}

{
  "id": "f1e2d3c4-b5a6-7890-cdef-123456789012",
  "created_at": "2026-03-27T14:30:00Z",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+15551234567",
  "email": "jane@example.com",
  "custom_fields": {
    "service_type": "HVAC",
    "source": "website"
  },
  "status": "active"
}

{
  "error": {
    "detail": "At least one of 'phone' or 'email' is required."
  }
}

{
  "error": {
    "detail": "<string>"
  }
}

Outbound Campaigns

Add Audience Member (Webhook)

Add a single contact to an outbound campaign audience via a public webhook. The contact is automatically enrolled in any active campaigns targeting this audience.

No API key or auth header is required — the webhook token in the URL is the authentication. You can find your webhook URL on the audience detail page in Craft.

Idempotent: if a contact with the same phone number or email already exists in the audience, the existing contact is returned without creating a duplicate.

POST

outbound-campaigns

webhook

{webhook_token}

Add Audience Member (Webhook)

curl --request POST \
  --url https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "5551234567",
  "email": "jane@example.com",
  "custom_fields": {
    "service_type": "HVAC",
    "source": "website"
  }
}
'

import requests

url = "https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/"

payload = {
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "5551234567",
    "email": "jane@example.com",
    "custom_fields": {
        "service_type": "HVAC",
        "source": "website"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: 'Jane',
    last_name: 'Doe',
    phone: '5551234567',
    email: 'jane@example.com',
    custom_fields: {service_type: 'HVAC', source: 'website'}
  })
};

fetch('https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/', 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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/",
  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([
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'phone' => '5551234567',
    'email' => 'jane@example.com',
    'custom_fields' => [
        'service_type' => 'HVAC',
        'source' => 'website'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/"

	payload := strings.NewReader("{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://data.craftflow.co/api/v1/outbound-campaigns/webhook/{webhook_token}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"phone\": \"5551234567\",\n  \"email\": \"jane@example.com\",\n  \"custom_fields\": {\n    \"service_type\": \"HVAC\",\n    \"source\": \"website\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "custom_fields": {}
}

{
  "id": "f1e2d3c4-b5a6-7890-cdef-123456789012",
  "created_at": "2026-03-27T14:30:00Z",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+15551234567",
  "email": "jane@example.com",
  "custom_fields": {
    "service_type": "HVAC",
    "source": "website"
  },
  "status": "active"
}

{
  "error": {
    "detail": "At least one of 'phone' or 'email' is required."
  }
}

{
  "error": {
    "detail": "<string>"
  }
}

Path Parameters

webhook_token

string<uuid>

required

The audience's unique webhook token. Found on the audience detail page in Craft.

Body

application/json

first_name

string

Contact's first name. Available as {{first_name}} in campaign message templates.

Maximum string length: 255

last_name

string

Contact's last name. Available as {{last_name}} in campaign message templates.

Maximum string length: 255

phone

string

Phone number. Accepts most common formats (+15551234567, 555-123-4567, (555) 123-4567). At least one of phone or email is required.

Maximum string length: 50

string<email>

Email address. At least one of phone or email is required.

custom_fields

object

Arbitrary key-value pairs. Each key becomes a template variable in campaign messages (e.g., {"service_type": "HVAC"} → {{service_type}}).

Show child attributes

Response

Contact with this phone or email already exists. Existing contact returned (idempotent).

string<uuid>

required

Unique identifier for the audience member.

created_at

string<date-time>

required

When the member was added to the audience.

first_name

string

required

Contact's first name.

last_name

string

required

Contact's last name.

phone

string

required

Phone number in E.164 format.

string<email>

required

Email address.

custom_fields

object

required

Custom key-value pairs attached to this contact.

Show child attributes

status

enum<string>

required

Current status of the audience member.

Available options:

active,

opted_out,

do_not_contact

Get Call Transcript

⌘I

Overview

Users

Teams

Field Recordings

Calls

Outbound Campaigns

Add Audience Member (Webhook)

Path Parameters

Body

Response