pcall PATCH "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8" '{
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
}'const res = await call("PATCH", "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8", {
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
});
const { data } = await res.json();res = call("PATCH", "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8", {
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'schedule' => [
'start_time' => '10:00',
'end_time' => '18:00'
]
]),
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/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"external_id": "wf-warehouse-chennai",
"name": "Warehouse associates - Chennai",
"collar": "blue",
"status": "active",
"default_methods": [
"data_enrichment",
"skill_verification"
],
"verification_methods": [
{
"type": "scenario-questions",
"enabled": true
},
{
"type": "ai-phone-call",
"enabled": true
}
],
"delivery": {
"whatsapp": true,
"voice_call": true,
"sms_backup": false
},
"schedule": {
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 6
},
"is_external": true,
"created_at": "2026-10-09T10:15:30.123Z",
"updated_at": "2026-10-09T11:02:41.000Z"
}
}{
"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>"
}
}Update a workflow
Change only the fields you send (send at least one), for example the send window. Fields not listed below cannot be changed.
Scope: workflows:write · Idempotency-Key: optional
pcall PATCH "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8" '{
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
}'const res = await call("PATCH", "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8", {
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
});
const { data } = await res.json();res = call("PATCH", "/api/v1/partner/workflows/WF_BG_261009101530123K7M2P9Q4X7R5T8", {
"schedule": {
"start_time": "10:00",
"end_time": "18:00"
}
})
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'schedule' => [
'start_time' => '10:00',
'end_time' => '18:00'
]
]),
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/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"schedule\": {\n \"start_time\": \"10:00\",\n \"end_time\": \"18:00\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"workflow_id": "WF_BG_261009101530123K7M2P9Q4X7R5T8",
"external_id": "wf-warehouse-chennai",
"name": "Warehouse associates - Chennai",
"collar": "blue",
"status": "active",
"default_methods": [
"data_enrichment",
"skill_verification"
],
"verification_methods": [
{
"type": "scenario-questions",
"enabled": true
},
{
"type": "ai-phone-call",
"enabled": true
}
],
"delivery": {
"whatsapp": true,
"voice_call": true,
"sms_backup": false
},
"schedule": {
"start_time": "10:00",
"end_time": "18:00",
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat"
],
"timezone": "Asia/Kolkata",
"max_retries": 3,
"retry_after_hours": 6
},
"is_external": true,
"created_at": "2026-10-09T10:15:30.123Z",
"updated_at": "2026-10-09T11:02:41.000Z"
}
}{
"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.
255Path Parameters
^WF_[A-Z]{2}_[A-Z0-9]{10,40}$Body
Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)
^[A-Za-z0-9._:-]{1,128}$1–200 characters.
1 - 200archived is reached only through DELETE
active, inactive, draft Methods a mandate uses when it does not send its own
1 - 3 elementsdata_enrichment, skill_verification, interest_collection Channels used to reach candidates
Show child attributes
Show child attributes
Send start_time and end_time together. Other keys merge; days is replaced as a whole list.
Show child attributes
Show child attributes

