cURL
pcall PUT "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4" '{
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": true
},
{
"skill_id": "sk_38973",
"verify": true
},
{
"skill_id": "sk_38824",
"verify": true
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": true
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
}'const res = await call("PUT", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4", {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": true
},
{
"skill_id": "sk_38973",
"verify": true
},
{
"skill_id": "sk_38824",
"verify": true
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": true
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
});
const { data } = await res.json();res = call("PUT", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4", {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": True
},
{
"skill_id": "sk_38973",
"verify": True
},
{
"skill_id": "sk_38824",
"verify": True
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": True
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": True
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": False
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workflow_id' => 'WF_BG_261009101530123K7M2P9Q4X7R5T8',
'title' => 'Warehouse Associate (Forklift)',
'company_name' => 'Acme Logistics Pvt Ltd',
'location_type' => 'india',
'location' => [
'city' => 'Chennai',
'state' => 'Tamil Nadu',
'pincode' => '600001'
],
'experience' => [
'min_years' => 1,
'max_years' => 5
],
'openings' => 12,
'salary' => [
'min' => 18000,
'max' => 24000,
'currency' => 'INR',
'period' => 'month'
],
'description' => 'Pick, pack and load orders in a busy warehouse. Forklift licence preferred.',
'shift' => 'Day shift',
'employment_type' => 'Full-time',
'owner' => [
'external_user_id' => 'recruiter_1042',
'name' => 'Priya Nair'
],
'methods' => [
'data_enrichment',
'skill_verification',
'interest_collection'
],
'skills' => [
[
'skill_id' => 'sk_36440',
'verify' => true
],
[
'skill_id' => 'sk_38973',
'verify' => true
],
[
'skill_id' => 'sk_38824',
'verify' => true
],
[
'skill_id' => 'sk_2338'
],
[
'skill_id' => 'sk_2452'
],
[
'name' => 'Reach Truck Operation',
'pending' => true
]
],
'enrichment_questions' => [
[
'key' => 'has_licence',
'type' => 'yes_no',
'text' => 'Do you hold a valid forklift licence?',
'knockout' => 'no',
'required' => true
],
[
'key' => 'why_this_job',
'type' => 'voice',
'text' => 'Tell us in your own words why you want this job.',
'required' => false
]
],
'interest_collection' => [
'other_roles' => [
'Forklift Operator',
'Store Keeper'
]
]
]),
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/mandates/{mandate_id}"
payload := strings.NewReader("{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"status": "preparing",
"flow_version": 1,
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"changed": true,
"warnings": [
"Pending skills are kept on the mandate but cannot be verified until resolved"
]
}
}{
"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>"
}
}Job mandates
Replace a job mandate
Replace the whole mandate (send the full body again). An identical resend changes nothing.
Scope: mandates:write · Idempotency-Key: optional
PUT
/
mandates
/
{mandate_id}
cURL
pcall PUT "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4" '{
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": true
},
{
"skill_id": "sk_38973",
"verify": true
},
{
"skill_id": "sk_38824",
"verify": true
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": true
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
}'const res = await call("PUT", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4", {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": true
},
{
"skill_id": "sk_38973",
"verify": true
},
{
"skill_id": "sk_38824",
"verify": true
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": true
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": true
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": false
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
});
const { data } = await res.json();res = call("PUT", "/api/v1/partner/mandates/JM_261009101612456H3N8W2L5C9V1Z4", {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"title": "Warehouse Associate (Forklift)",
"company_name": "Acme Logistics Pvt Ltd",
"location_type": "india",
"location": {
"city": "Chennai",
"state": "Tamil Nadu",
"pincode": "600001"
},
"experience": {
"min_years": 1,
"max_years": 5
},
"openings": 12,
"salary": {
"min": 18000,
"max": 24000,
"currency": "INR",
"period": "month"
},
"description": "Pick, pack and load orders in a busy warehouse. Forklift licence preferred.",
"shift": "Day shift",
"employment_type": "Full-time",
"owner": {
"external_user_id": "recruiter_1042",
"name": "Priya Nair"
},
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"skills": [
{
"skill_id": "sk_36440",
"verify": True
},
{
"skill_id": "sk_38973",
"verify": True
},
{
"skill_id": "sk_38824",
"verify": True
},
{
"skill_id": "sk_2338"
},
{
"skill_id": "sk_2452"
},
{
"name": "Reach Truck Operation",
"pending": True
}
],
"enrichment_questions": [
{
"key": "has_licence",
"type": "yes_no",
"text": "Do you hold a valid forklift licence?",
"knockout": "no",
"required": True
},
{
"key": "why_this_job",
"type": "voice",
"text": "Tell us in your own words why you want this job.",
"required": False
}
],
"interest_collection": {
"other_roles": [
"Forklift Operator",
"Store Keeper"
]
}
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workflow_id' => 'WF_BG_261009101530123K7M2P9Q4X7R5T8',
'title' => 'Warehouse Associate (Forklift)',
'company_name' => 'Acme Logistics Pvt Ltd',
'location_type' => 'india',
'location' => [
'city' => 'Chennai',
'state' => 'Tamil Nadu',
'pincode' => '600001'
],
'experience' => [
'min_years' => 1,
'max_years' => 5
],
'openings' => 12,
'salary' => [
'min' => 18000,
'max' => 24000,
'currency' => 'INR',
'period' => 'month'
],
'description' => 'Pick, pack and load orders in a busy warehouse. Forklift licence preferred.',
'shift' => 'Day shift',
'employment_type' => 'Full-time',
'owner' => [
'external_user_id' => 'recruiter_1042',
'name' => 'Priya Nair'
],
'methods' => [
'data_enrichment',
'skill_verification',
'interest_collection'
],
'skills' => [
[
'skill_id' => 'sk_36440',
'verify' => true
],
[
'skill_id' => 'sk_38973',
'verify' => true
],
[
'skill_id' => 'sk_38824',
'verify' => true
],
[
'skill_id' => 'sk_2338'
],
[
'skill_id' => 'sk_2452'
],
[
'name' => 'Reach Truck Operation',
'pending' => true
]
],
'enrichment_questions' => [
[
'key' => 'has_licence',
'type' => 'yes_no',
'text' => 'Do you hold a valid forklift licence?',
'knockout' => 'no',
'required' => true
],
[
'key' => 'why_this_job',
'type' => 'voice',
'text' => 'Tell us in your own words why you want this job.',
'required' => false
]
],
'interest_collection' => [
'other_roles' => [
'Forklift Operator',
'Store Keeper'
]
]
]),
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/mandates/{mandate_id}"
payload := strings.NewReader("{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/mandates/{mandate_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"WF_BG_261009101530123K7M2P9Q4X7R5T8\",\n \"title\": \"Warehouse Associate (Forklift)\",\n \"company_name\": \"Acme Logistics Pvt Ltd\",\n \"location_type\": \"india\",\n \"location\": {\n \"city\": \"Chennai\",\n \"state\": \"Tamil Nadu\",\n \"pincode\": \"600001\"\n },\n \"experience\": {\n \"min_years\": 1,\n \"max_years\": 5\n },\n \"openings\": 12,\n \"salary\": {\n \"min\": 18000,\n \"max\": 24000,\n \"currency\": \"INR\",\n \"period\": \"month\"\n },\n \"description\": \"Pick, pack and load orders in a busy warehouse. Forklift licence preferred.\",\n \"shift\": \"Day shift\",\n \"employment_type\": \"Full-time\",\n \"owner\": {\n \"external_user_id\": \"recruiter_1042\",\n \"name\": \"Priya Nair\"\n },\n \"methods\": [\n \"data_enrichment\",\n \"skill_verification\",\n \"interest_collection\"\n ],\n \"skills\": [\n {\n \"skill_id\": \"sk_36440\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38973\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_38824\",\n \"verify\": true\n },\n {\n \"skill_id\": \"sk_2338\"\n },\n {\n \"skill_id\": \"sk_2452\"\n },\n {\n \"name\": \"Reach Truck Operation\",\n \"pending\": true\n }\n ],\n \"enrichment_questions\": [\n {\n \"key\": \"has_licence\",\n \"type\": \"yes_no\",\n \"text\": \"Do you hold a valid forklift licence?\",\n \"knockout\": \"no\",\n \"required\": true\n },\n {\n \"key\": \"why_this_job\",\n \"type\": \"voice\",\n \"text\": \"Tell us in your own words why you want this job.\",\n \"required\": false\n }\n ],\n \"interest_collection\": {\n \"other_roles\": [\n \"Forklift Operator\",\n \"Store Keeper\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"mandate_id": "JM_261009101612456H3N8W2L5C9V1Z4",
"job_id": "job-10452",
"status": "preparing",
"flow_version": 1,
"methods": [
"data_enrichment",
"skill_verification",
"interest_collection"
],
"changed": true,
"warnings": [
"Pending skills are kept on the mandate but cannot be verified until resolved"
]
}
}{
"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:
255Path Parameters
Record's mandate id (JM_...): the mandate_id returned when you create the mandate
Pattern:
^JM_[A-Z0-9]{10,40}$Body
application/json
One of your workflows
Pattern:
^WF_[A-Z]{2}_[A-Z0-9]{10,40}$Required string length:
1 - 200Required string length:
1 - 2005 to 10 recommended; fewer than 5 is a warning
Required array length:
1 - 50 elements- Option 1
- Option 2
Show child attributes
Show child attributes
Where the job is: "india" (default; give location) or "abroad" (give countries). Same as the playground's Abroad option
Available options:
india, abroad A place in India (find it with GET /locations). Leave it out for an abroad job
Show child attributes
Show child attributes
Only with location_type "abroad": 1 to 10 ISO 3166-1 alpha-2 codes such as SG (list them with GET /countries). India is not selectable
Maximum array length:
20Pattern:
^[A-Za-z]{2}$Whole years, 0 to 50
Show child attributes
Show child attributes
Required range:
1 <= x <= 100000Show child attributes
Show child attributes
Up to 1,500 characters (the question generator's limit)
Maximum string length:
1500Use a value from GET /shifts so the playground shows it as a choice; any other text is kept as sent
Maximum string length:
100Use a value from GET /employment-types so the playground shows it as a choice; any other text is kept as sent
Maximum string length:
100The recruiter in your ATS; defaults to x-on-behalf-of
Show child attributes
Show child attributes
Any non-empty mix; candidates always go enrichment → skills → interest. Omit to use the workflow's default.
Required array length:
1 - 3 elementsAvailable options:
data_enrichment, skill_verification, interest_collection 0 to 5 enrichment questions (up to 10 when data_enrichment is the only method)
Maximum array length:
50Show child attributes
Show child attributes
Show child attributes
Show child attributes