How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Prosper AI

Prosper AI Campaigns API

The Campaigns API from Prosper AI — 7 operation(s) for campaigns.

Documentation Provider Profile APIs.io OpenAPI GitHub

Prosper AI Campaigns API is one of 6 APIs that Prosper AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a quickstart, and authentication docs.

This API exposes 9 operations across 7 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://voice.getprosperapp.com.

9 operations 7 paths 32 schemas 1 DELETE3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://voice.getprosperapp.com
Resource Areas
1

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Campaigns 9
POST
/api/v1/campaigns/{campaign_id}/calls
Campaign Calls
campaign_calls_api_v1_campaigns__campaign_id__calls_post 1 param body → 200422
POST
/api/v1/campaigns/{campaign_id}/targets
Add Targets
add_targets_api_v1_campaigns__campaign_id__targets_post 1 param body → 200422
DELETE
/api/v1/campaigns/{campaign_id}/targets
Delete Targets
delete_targets_api_v1_campaigns__campaign_id__targets_delete 1 param body → 200422
GET
/api/v1/campaigns/{campaign_id}/targets
Get Campaign Targets
get_campaign_targets_api_v1_campaigns__campaign_id__targets_get 8 params → 200422
GET
/api/v1/campaigns/{campaign_id}/variables
Get Required Variables
get_required_variables_api_v1_campaigns__campaign_id__variables_get 1 param → 200422
POST
/api/v1/campaigns/{campaign_id}/targets/{target_id}/step/{friendly_id}
Receive Webhook Step
receive_webhook_step_api_v1_campaigns__campaign_id__targets__target_id__step__friendly_id__post 3 params body → 200422
POST
/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}
Receive Ehr Event Step
receive_ehr_event_step_api_v1_campaigns__campaign_id__ehr_event__friendly_id__post 2 params body → 200422
POST
/api/v1/campaigns/{campaign_id}/webhooks/rerun-failed
Rerun Failed Webhooks
rerun_failed_webhooks_api_v1_campaigns__campaign_id__webhooks_rerun_failed_post 1 param body → 202422
GET
/api/v1/campaigns/{campaign_id}/patient/targets
Get Patient Campaign Targets
get_patient_campaign_targets_api_v1_campaigns__campaign_id__patient_targets_get 8 params → 200422

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CampaignTargetPatientResponse (24 properties), CampaignTargetResponse (24 properties), WeekSchedule (8 properties), TargetInput (7 properties). Each schema is shown below with its type and property counts.

CampaignTargetStatus
string
CampaignTargetPatientResponse
object
Simplified response for patient campaign targets that uses the optimized vwcampaigntargetsexportpatient view. This view excludes faxlinks and payorapidata for…
24 properties 18 required
EHREventType
string
CampaignTargetResponse
object
24 properties 18 required
HumanOnlySubcategory
string
WeekSchedule
object
8 properties
IVRLoopSubCategory
string
CampaignTargetPayorResolution
string
PatientIncomingSchedulingCallCategory
string
AddTargetsRequest
object
3 properties
InputDataIssueSubCategory
string
ProviderCallCategory
string
PayorCallCategory
string
PatientInput
object
6 properties
HTTPValidationError
object
1 property
TargetInput
object
7 properties 1 required
PaginatedCampaignTargetsResponse
object
3 properties 1 required
CampaignTargetPatientResolution
string
PatientCallCategory
string
PatientIncomingCallCategory
string
UnprocessableByPhoneSubCategory
string
DeleteTargetsRequest
object
1 property 1 required
ServiceNotAvailableSubCategory
string
LaunchTargetsRequest
object
3 properties
TransferSubCategory
string
ValidationError
object
5 properties 3 required
NotFoundSubCategory
string
TimeIntervalNoTz
object
2 properties 2 required
PaginatedCampaignTargetsPatientResponse
object
Paginated response for patient campaign targets using the optimized vwcampaigntargetsexportpatient view (no faxlinks or payorapidata).
3 properties 1 required
RerunFailedWebhooksBody
object
2 properties 2 required
TargetInputPhoneNumber
object
2 properties 1 required
Body_receive_ehr_event_step_api_v1_campaigns__campaign_id__ehr_event__friendly_id__post
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prosper-ai-campaigns-api-openapi.yml Raw ↑

Other APIs Prosper AI publishes across the network.

Prosper AI API Keys API
AE Profile APIs.io
Prosper AI Call Logs API
AE Profile APIs.io
Prosper AI Live Calls API
AE Profile APIs.io
Prosper AI Status API
AE Profile APIs.io
Prosper AI Targets API
AE Profile APIs.io
#Campaigns
← Back to P APIs
API Details
ID
prosper-ai:prosper-ai-campaigns-api
Base URL
https://voice.getprosperapp.com
Docs
https://docs.getprosperapp.com/introduction
Provider
Prosper AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=prosper-ai-campaigns-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/prosper-ai-campaigns-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Prosper AI Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.