Campaigns
Get a campaign
Returns a single campaign by its campaign ID.
Authorization
ApiKeyAuth X-API-Key<token>
API key generated from your Vayaflow dashboard Settings page
In: header
Path Parameters
campaignId*string
The campaign ID (e.g., "MTM1")
Response Body
application/json
application/json
application/json
package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://api.vayaflow.com/api/v1/campaigns/string" 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": {
"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"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}