Campaigns
List campaigns
Returns all campaigns for the authenticated tenant. Supports pagination and filtering.
Authorization
ApiKeyAuth X-API-Key<token>
API key generated from your Vayaflow dashboard Settings page
In: header
Query Parameters
page?string
Page number
limit?string
Items per page
active?string
Filter by active status
Value in
"true" | "false"clientId?string
Filter by client ID
offerId?string
Filter by offer ID
includeArchived?string
Include archived campaigns
Value in
"true" | "false"search?string
Search by name, campaignId, clientName, or offerName
Response Body
application/json
application/json
package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.vayaflow.com/api/v1/campaigns" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}{
"success": true,
"data": {
"campaigns": [
{
"campaignId": "string",
"name": "string",
"active": true,
"offer": {
"offerId": "string",
"offerName": "string"
},
"client": {
"clientId": "string",
"clientName": "string"
},
"managerId": "string",
"questionnaireId": "string",
"documents": [
{
"documentId": "string",
"kind": "esign",
"signTemplateId": "string",
"staticAssetId": "string",
"type": "string",
"name": "string",
"conditions": {
"logicalOperator": "AND",
"subRules": [
{
"logicalOperator": "AND",
"conditions": [
{
"field": "string",
"operator": "equals",
"value": [
null
],
"valueSetId": "string",
"prompt": "string",
"maxSeverity": "disqualify"
}
]
}
],
"appliesAt": "ingestion",
"isActive": true,
"name": "string"
},
"fieldMappingOverrides": [
{
"id": "string",
"providerFieldName": "string",
"providerFieldId": "string",
"providerFieldLabel": "string",
"providerFieldRequired": true,
"providerFieldType": "string",
"autoFill": true,
"fallbackTemplate": "string",
"sourceType": "field_library",
"sourceValue": "string",
"sourceLabel": "string"
}
],
"isActive": true,
"required": true,
"autoSend": true,
"expiresInDays": 0,
"order": 0
}
],
"campaignAiAgents": {
"rep": {
"agentId": "string"
},
"repTest": {
"agentId": "string"
}
},
"firstIntakeAction": {
"enabled": true,
"action": "voice_ai",
"humanReview": {
"reason": "string",
"priority": "high"
},
"workflow": {
"workflowDefinitionId": "string"
}
},
"qualification": {
"rules": [
{
"logicalOperator": "AND",
"subRules": [
{
"logicalOperator": "AND",
"conditions": [
{
"field": "string",
"operator": "equals",
"value": [
null
],
"valueSetId": "string",
"prompt": "string",
"maxSeverity": "disqualify"
}
]
}
],
"appliesAt": "ingestion",
"isActive": true,
"name": "string"
}
],
"tcpaPolicy": {
"deliveryPolicy": {
"required": true
},
"ingestionPolicy": {
"requireSourceAttestation": true
},
"campaignAttestation": {
"enabled": true,
"attestedBy": "string",
"attestedAt": "string",
"note": "string"
}
},
"dedupeOverride": null,
"autoRoutingEnabled": true,
"routingRules": [
{
"routeName": "string",
"active": true,
"priority": 0,
"logicalOperator": "AND",
"subRules": [
{
"logicalOperator": "AND",
"conditions": [
{
"field": "string",
"operator": "equals",
"value": [
null
],
"valueSetId": "string",
"prompt": "string",
"maxSeverity": "disqualify"
}
]
}
],
"routeTo": {
"campaignId": "string",
"clientName": "string",
"offerName": "string"
}
}
],
"fallbackCampaigns": [
"string"
]
},
"ingestion": {
"sources": [
{
"sourceId": "string",
"name": "string",
"supplierId": "string",
"postingSpecId": "string",
"mode": "direct_post",
"apiKey": "string",
"apiKeyEncrypted": {
"ciphertext": "string",
"encryptedDataKey": "string",
"iv": "string",
"authTag": "string",
"kmsKeyId": "string"
},
"keyPrefix": "string",
"specShareHash": "string",
"caps": [
{
"active": true,
"cap": 0,
"type": "daily",
"startDate": "string",
"endDate": "string"
}
],
"costMilestones": [
{
"leadStatus": "lead_ingested",
"amount": 0,
"currency": "USD",
"validFrom": "string",
"validTo": "string",
"conditions": {
"logicalOperator": "AND",
"subRules": [
{
"logicalOperator": "AND",
"conditions": [
{
"field": "string",
"operator": "equals",
"value": [
null
],
"valueSetId": "string",
"prompt": "string",
"maxSeverity": "disqualify"
}
]
}
],
"appliesAt": "ingestion",
"isActive": true,
"name": "string"
},
"notes": "string",
"active": true
}
],
"shortCircuitSyncEvaluation": true,
"placement": {
"applyRoutingRules": true,
"applyFallbackCampaigns": true
},
"active": true,
"createdAt": "string",
"updatedAt": "string"
}
]
},
"delivery": {
"deliveryEndpointId": "string",
"deliveryLimits": [
{
"active": true,
"cap": 0,
"type": "daily",
"action": "queue",
"startDate": "string",
"endDate": "string",
"routeToCampaignId": "string"
}
],
"deliverySchedule": {
"timezone": "string",
"action": "queue",
"specificDays": [
{
"active": true,
"day": "Monday",
"startTime": "string",
"endTime": "string"
}
],
"routeToCampaignId": "string"
},
"revenueMilestones": [
{
"leadStatus": "delivered",
"amount": 0,
"currency": "USD",
"validFrom": "string",
"validTo": "string",
"conditions": {
"logicalOperator": "AND",
"subRules": [
{
"logicalOperator": "AND",
"conditions": [
{
"field": "string",
"operator": "equals",
"value": [
null
],
"valueSetId": "string",
"prompt": "string",
"maxSeverity": "disqualify"
}
]
}
],
"appliesAt": "ingestion",
"isActive": true,
"name": "string"
},
"notes": "string",
"active": true
}
],
"discrepancyHold": "off"
},
"notes": "string",
"tags": [
"string"
],
"externalId": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string",
"lastLeadReceivedAt": "string"
}
],
"pagination": {
"total": 0,
"page": 0,
"limit": 0
}
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}Send leads to auto dialer
Schedules one or more leads for the next available auto-dialer call slot. Each lead is matched to its campaign's auto-dialer configuration, and the service determines the optimal call time based on the lead's timezone, the sequencing rules, and attempt history. Leads that cannot be scheduled (e.g. inactive config, max attempts reached, excluded status) are reported in the failed array. Processes up to 200 leads per request with controlled concurrency.
Get a campaign
Returns a single campaign by its campaign ID.