cURL
pcall POST "/api/v1/partner/campaigns" '{
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
}'const res = await call("POST", "/api/v1/partner/campaigns", {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
});
const { data } = await res.json();res = call("POST", "/api/v1/partner/campaigns", {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/campaigns",
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([
'mandate_id' => 'JM_261009101612456H3N8W2L5C9V1Z4',
'name' => 'Warehouse Associate - October batch',
'external_id' => 'ats-campaign-5521',
'start' => 'now',
'language' => 'en',
'candidates' => [
[
'external_id' => 'cand-88231',
'name' => 'Ravi Kumar',
'phone' => '98765 43210'
],
[
'external_id' => 'cand-88232',
'name' => 'Meena Devi',
'phone' => '+91 98123 45678'
],
[
'external_id' => 'cand-88233',
'name' => 'Karthik Raj',
'phone' => '99000 11122'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-secret-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-bc.userecord.io/api/v1/partner/campaigns"
payload := strings.NewReader("{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-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-bc.userecord.io/api/v1/partner/campaigns")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/campaigns")
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["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaign": {
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"external_id": "ats-campaign-5521",
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"name": "Warehouse Associate - October batch",
"status": "waiting_for_questions",
"blocked": null,
"language": "english",
"candidates": {
"total": 3,
"sent": 0,
"queued": 3,
"failed": 0
},
"created_at": "2026-10-05T09:12:44.000Z",
"started_at": "2026-10-05T09:12:45.000Z",
"sent_at": null,
"paused_at": null
},
"accepted": 3,
"rejected": [],
"credits_reserved": 3
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Campaigns
Create a campaign
Send your candidates (name + phone) for a mandate. Record contacts and verifies them. Returns campaign_id.
Scope: campaigns:write · Idempotency-Key: optional
This contacts real candidates. Build against a TEST key first.
POST
/
campaigns
cURL
pcall POST "/api/v1/partner/campaigns" '{
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
}'const res = await call("POST", "/api/v1/partner/campaigns", {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
});
const { data } = await res.json();res = call("POST", "/api/v1/partner/campaigns", {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"name": "Warehouse Associate - October batch",
"external_id": "ats-campaign-5521",
"start": "now",
"language": "en",
"candidates": [
{
"external_id": "cand-88231",
"name": "Ravi Kumar",
"phone": "98765 43210"
},
{
"external_id": "cand-88232",
"name": "Meena Devi",
"phone": "+91 98123 45678"
},
{
"external_id": "cand-88233",
"name": "Karthik Raj",
"phone": "99000 11122"
}
]
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/campaigns",
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([
'mandate_id' => 'JM_261009101612456H3N8W2L5C9V1Z4',
'name' => 'Warehouse Associate - October batch',
'external_id' => 'ats-campaign-5521',
'start' => 'now',
'language' => 'en',
'candidates' => [
[
'external_id' => 'cand-88231',
'name' => 'Ravi Kumar',
'phone' => '98765 43210'
],
[
'external_id' => 'cand-88232',
'name' => 'Meena Devi',
'phone' => '+91 98123 45678'
],
[
'external_id' => 'cand-88233',
'name' => 'Karthik Raj',
'phone' => '99000 11122'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-secret-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-bc.userecord.io/api/v1/partner/campaigns"
payload := strings.NewReader("{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-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-bc.userecord.io/api/v1/partner/campaigns")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/campaigns")
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["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mandate_id\": \"JM_261009101612456H3N8W2L5C9V1Z4\",\n \"name\": \"Warehouse Associate - October batch\",\n \"external_id\": \"ats-campaign-5521\",\n \"start\": \"now\",\n \"language\": \"en\",\n \"candidates\": [\n {\n \"external_id\": \"cand-88231\",\n \"name\": \"Ravi Kumar\",\n \"phone\": \"98765 43210\"\n },\n {\n \"external_id\": \"cand-88232\",\n \"name\": \"Meena Devi\",\n \"phone\": \"+91 98123 45678\"\n },\n {\n \"external_id\": \"cand-88233\",\n \"name\": \"Karthik Raj\",\n \"phone\": \"99000 11122\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaign": {
"campaign_id": "asmnt_9f2c41d7a8b3e65f",
"external_id": "ats-campaign-5521",
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"name": "Warehouse Associate - October batch",
"status": "waiting_for_questions",
"blocked": null,
"language": "english",
"candidates": {
"total": 3,
"sent": 0,
"queued": 3,
"failed": 0
},
"created_at": "2026-10-05T09:12:44.000Z",
"started_at": "2026-10-05T09:12:45.000Z",
"sent_at": null,
"paused_at": null
},
"accepted": 3,
"rejected": [],
"credits_reserved": 3
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).
Headers
Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.
Maximum string length:
255Body
application/json
now: send straight away. manual: create a draft and start it later
Available options:
now, manual 1–1,000 of { name, phone, external_id? }. Phone: 10 digits or with country code. Bad numbers come back in rejected.
Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Record's job mandate id: the mandate_id returned when you created the job mandate. Send this or job_id, not both
Pattern:
^JM_[A-Z0-9]{10,40}$Your own job id, if the mandate was created with one. Send this or mandate_id, not both
Pattern:
^[A-Za-z0-9._:-]{1,128}$Defaults to the job title and today's date
Required string length:
1 - 120Your own id for this campaign. Must be unique
Pattern:
^[A-Za-z0-9._:-]{1,128}$The language candidates are contacted in. Default en
Available options:
en, hi, ta, te, kn, ml