Pause Workflow
curl --request POST \
--url https://api.agents.timepay.ai/api/v1/workflows/action/pause \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"campaignId": "<string>",
"filters": {
"ids": [
"<string>"
],
"exclude_ids": [
"<string>"
],
"payment_status": [
"<string>"
],
"language": [
"<string>"
],
"custom": {}
}
}
'import requests
url = "https://api.agents.timepay.ai/api/v1/workflows/action/pause"
payload = {
"campaignId": "<string>",
"filters": {
"ids": ["<string>"],
"exclude_ids": ["<string>"],
"payment_status": ["<string>"],
"language": ["<string>"],
"custom": {}
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignId: '<string>',
filters: {
ids: ['<string>'],
exclude_ids: ['<string>'],
payment_status: ['<string>'],
language: ['<string>'],
custom: {}
}
})
};
fetch('https://api.agents.timepay.ai/api/v1/workflows/action/pause', 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://api.agents.timepay.ai/api/v1/workflows/action/pause",
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([
'campaignId' => '<string>',
'filters' => [
'ids' => [
'<string>'
],
'exclude_ids' => [
'<string>'
],
'payment_status' => [
'<string>'
],
'language' => [
'<string>'
],
'custom' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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://api.agents.timepay.ai/api/v1/workflows/action/pause"
payload := strings.NewReader("{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.agents.timepay.ai/api/v1/workflows/action/pause")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agents.timepay.ai/api/v1/workflows/action/pause")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow pause applied to the whole campaign",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "campaign",
"previousStatus": "resumed"
}
}
{
"success": true,
"message": "Workflow pause applied to 1 of 1 customers",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "customers",
"matched": 1
},
"results": {
"matched": 1,
"updated": 1,
"failed": 0,
"errors": []
}
}
{
"success": false,
"message": "Customer workflows can only be modified while the campaign workflow running.",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"currentStatus": "paused"
}
}
{
"success": false,
"message": "Validation failed",
"errors": [
"campaignId is required and must be a string"
]
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"message": "Campaign not found"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Workflows
Pause Workflow
Pause a workflow for an entire campaign or customers matching optional filters.
Pause Workflow
curl --request POST \
--url https://api.agents.timepay.ai/api/v1/workflows/action/pause \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"campaignId": "<string>",
"filters": {
"ids": [
"<string>"
],
"exclude_ids": [
"<string>"
],
"payment_status": [
"<string>"
],
"language": [
"<string>"
],
"custom": {}
}
}
'import requests
url = "https://api.agents.timepay.ai/api/v1/workflows/action/pause"
payload = {
"campaignId": "<string>",
"filters": {
"ids": ["<string>"],
"exclude_ids": ["<string>"],
"payment_status": ["<string>"],
"language": ["<string>"],
"custom": {}
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaignId: '<string>',
filters: {
ids: ['<string>'],
exclude_ids: ['<string>'],
payment_status: ['<string>'],
language: ['<string>'],
custom: {}
}
})
};
fetch('https://api.agents.timepay.ai/api/v1/workflows/action/pause', 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://api.agents.timepay.ai/api/v1/workflows/action/pause",
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([
'campaignId' => '<string>',
'filters' => [
'ids' => [
'<string>'
],
'exclude_ids' => [
'<string>'
],
'payment_status' => [
'<string>'
],
'language' => [
'<string>'
],
'custom' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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://api.agents.timepay.ai/api/v1/workflows/action/pause"
payload := strings.NewReader("{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.agents.timepay.ai/api/v1/workflows/action/pause")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agents.timepay.ai/api/v1/workflows/action/pause")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaignId\": \"<string>\",\n \"filters\": {\n \"ids\": [\n \"<string>\"\n ],\n \"exclude_ids\": [\n \"<string>\"\n ],\n \"payment_status\": [\n \"<string>\"\n ],\n \"language\": [\n \"<string>\"\n ],\n \"custom\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow pause applied to the whole campaign",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "campaign",
"previousStatus": "resumed"
}
}
{
"success": true,
"message": "Workflow pause applied to 1 of 1 customers",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "customers",
"matched": 1
},
"results": {
"matched": 1,
"updated": 1,
"failed": 0,
"errors": []
}
}
{
"success": false,
"message": "Customer workflows can only be modified while the campaign workflow running.",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"currentStatus": "paused"
}
}
{
"success": false,
"message": "Validation failed",
"errors": [
"campaignId is required and must be a string"
]
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"message": "Campaign not found"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Headers
string
required
Bearer token for authentication (e.g.,
Bearer <your_token>).string
Optional. Use this header only when the authenticated user belongs to multiple organizations. It identifies the organization to target for this action.
Body Parameters
string
required
The unique identifier of the campaign. When supplied without
filters, the workflow is paused for the entire campaign.object
Optional filters that limit the action to matching customers. When present, the action does not apply to the whole campaign.
Show properties
Show properties
string[]
Customer IDs (
loan_id or lead_id) to target. Maximum 50 IDs.string[]
Customer IDs (
loan_id or lead_id) to exclude.string[]
Payment statuses to match.
string[]
Customer language preferences to match.
object
Custom field exact-match filters as key-value pairs. Values can be a single string or an array of strings.
Example
{
"branch": "mumbai",
"product_type": ["personal_loan", "home_loan"]
}
Customer-level workflow actions (requests with
filters) can only be performed while the campaign workflow is running.Response
boolean
Indicates whether the action was successful.
string
A description of the action applied or the reason it could not be applied.
object
Details of the action and its scope.
Show properties
Show properties
string
The campaign ID used for the request.
string
The action performed:
pause.string
Whether the action applied to
campaign or customers.string
The prior campaign status. Present for whole-campaign actions.
integer
Number of customers matched. Present for customer actions.
string
The current workflow status when the action cannot be applied.
object
{
"success": true,
"message": "Workflow pause applied to the whole campaign",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "campaign",
"previousStatus": "resumed"
}
}
{
"success": true,
"message": "Workflow pause applied to 1 of 1 customers",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"scope": "customers",
"matched": 1
},
"results": {
"matched": 1,
"updated": 1,
"failed": 0,
"errors": []
}
}
{
"success": false,
"message": "Customer workflows can only be modified while the campaign workflow running.",
"data": {
"campaignId": "lSKmrINyfZEywkpPCaGv",
"action": "pause",
"currentStatus": "paused"
}
}
{
"success": false,
"message": "Validation failed",
"errors": [
"campaignId is required and must be a string"
]
}
{
"success": false,
"error": "Unauthorized",
"message": "Missing or invalid authorization header"
}
{
"success": false,
"error": "Forbidden",
"message": "You don't have the required permission to perform this action"
}
{
"success": false,
"message": "Campaign not found"
}
{
"success": false,
"error": "InternalServerError",
"message": "An unexpected error occurred"
}
Error Codes
| Status | Description |
|---|---|
400 | Validation error - campaignId is required |
401 | Unauthorized - missing or invalid authorization header |
403 | Forbidden - insufficient permission to modify the workflow |
404 | Campaign not found |
409 | Customer workflows can only be modified while the campaign workflow is running |
500 | Internal server error |