{"templateId":"openapi_docs","versions":[],"sharedDataIds":{"openAPIDocsStore":"oas-API Docs/@2023-11-29/api-public.yaml","sidebar":"sidebar-sidebar.yaml__api-docs_api-public"},"props":{"definitionId":"API Docs/@2023-11-29/api-public.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-docs/api-public","seo":{"title":"Campaigns","description":"This object allows you to create custom Campaigns. A Campaign is characterized by a set of rules, defined\nas a SQL query created in Redash and associated with the Campaign. A Campaign can be triggered at predefined\nintervals. For example, a Campaign can be triggered every day to add borrowers who are 30 days past due. Campaigns\ncan also be manually triggered.\nWhen a Campaign is triggered by schedule or manually, a query is executed against the lender's replica data and\nreturns a list of person IDs. The output is sent to the configured Contact Exporter to be written as a configurable\nCSV file with contact information required by auto dialers and other systems.\n"},"itemId":"campaigns","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"peach-docs-dev.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 790dd2637efddd54756eabb102d0e234.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"J2_s4i_J_jym4I0ncIdFaV2myB-MDzqm4w3JjxUo3jpFtPeFJNpa9Q==","x-forwarded-for":"216.73.216.253, 44.206.14.241, 64.252.67.232","x-forwarded-host":"peach-docs-dev.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-b3c7e5b0-db06-4985-abf0-cc55c7fea48a"},"remoteAddr":{"hostname":"::ffff:10.0.2.113","port":56556},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/api-public/campaigns","userData":{"isAuthenticated":false,"teams":["anonymous"]}}