# API Reference

Every endpoint of the Victoria AI REST API, generated from its OpenAPI specification. Requests and responses are JSON, and every request carries your API key as a Bearer token.

Base URL: `https://api.versionseven.ai/v1`

## Auth

Check that an API key works and see which organization it belongs to.

- [Verify an API key](https://docs.versionseven.ai/api-reference/auth/verify-api-key): `GET /v1/auth/verify`

## Sender accounts

The LinkedIn and email accounts connected to your organization for outreach, whether each one is still connected, and links that connect or reconnect one.

- [List sender accounts](https://docs.versionseven.ai/api-reference/accounts/list-accounts): `GET /v1/accounts`
- [Create a connect link](https://docs.versionseven.ai/api-reference/accounts/create-connect-link): `POST /v1/accounts/connect-link`

## Leads

Create leads, enrol them in campaigns, find them with filters, update them, and remove them from campaigns.

- [Create a lead](https://docs.versionseven.ai/api-reference/leads/create-lead): `POST /v1/leads`
- [List leads](https://docs.versionseven.ai/api-reference/leads/list-leads): `GET /v1/leads`
- [Retrieve a lead](https://docs.versionseven.ai/api-reference/leads/retrieve-lead): `GET /v1/leads/{lead_id}`
- [Update a lead](https://docs.versionseven.ai/api-reference/leads/update-lead): `PATCH /v1/leads/{lead_id}`
- [Delete a lead or remove it from a campaign](https://docs.versionseven.ai/api-reference/leads/remove-lead-from-campaign): `DELETE /v1/leads/{lead_id}`
- [Create a standalone lead](https://docs.versionseven.ai/api-reference/leads/create-standalone-lead): `POST /v1/leads/create` (deprecated)

## Campaigns

Create and manage campaigns: their sequences, AI fields, senders, reply agent, activation preflight, analytics, A/B tests, bookings, lead queue, and the webhooks that receive prospect replies.

- [List campaigns](https://docs.versionseven.ai/api-reference/campaigns/list-campaigns): `GET /v1/campaigns`
- [Create a campaign](https://docs.versionseven.ai/api-reference/campaigns/create-campaign): `POST /v1/campaigns`
- [Retrieve a campaign](https://docs.versionseven.ai/api-reference/campaigns/retrieve-campaign): `GET /v1/campaigns/{campaign_id}`
- [Update a campaign](https://docs.versionseven.ai/api-reference/campaigns/update-campaign): `PATCH /v1/campaigns/{campaign_id}`
- [Replace a campaign's sequence](https://docs.versionseven.ai/api-reference/campaigns/replace-sequence): `PUT /v1/campaigns/{campaign_id}/sequence`
- [Update a sequence step](https://docs.versionseven.ai/api-reference/campaigns/update-sequence-step): `PATCH /v1/campaigns/{campaign_id}/sequence/steps/{step_id}`
- [Get campaign analytics](https://docs.versionseven.ai/api-reference/campaigns/get-campaign-analysis): `GET /v1/campaigns/{campaign_id}/analysis`
- [Get a campaign's queue](https://docs.versionseven.ai/api-reference/campaigns/get-campaign-queue): `GET /v1/campaigns/{campaign_id}/queue`
- [Get the activation preflight](https://docs.versionseven.ai/api-reference/campaigns/get-campaign-preflight): `GET /v1/campaigns/{campaign_id}/preflight`
- [Assign sender accounts](https://docs.versionseven.ai/api-reference/campaigns/assign-senders): `PUT /v1/campaigns/{campaign_id}/senders`
- [List AI fields](https://docs.versionseven.ai/api-reference/campaigns/list-ai-fields): `GET /v1/campaigns/{campaign_id}/ai-fields`
- [Create an AI field](https://docs.versionseven.ai/api-reference/campaigns/create-ai-field): `POST /v1/campaigns/{campaign_id}/ai-fields`
- [Update an AI field](https://docs.versionseven.ai/api-reference/campaigns/update-ai-field): `PATCH /v1/campaigns/{campaign_id}/ai-fields/{field_id}`
- [Get the reply agent](https://docs.versionseven.ai/api-reference/campaigns/get-responder): `GET /v1/campaigns/{campaign_id}/responder`
- [Update the reply agent](https://docs.versionseven.ai/api-reference/campaigns/update-responder): `PATCH /v1/campaigns/{campaign_id}/responder`
- [Preview a campaign's messages](https://docs.versionseven.ai/api-reference/campaigns/preview-campaign): `POST /v1/campaigns/{campaign_id}/preview`
- [List meetings booked](https://docs.versionseven.ai/api-reference/campaigns/list-bookings): `GET /v1/campaigns/{campaign_id}/bookings`
- [Turn A/B testing on or off](https://docs.versionseven.ai/api-reference/campaigns/set-ab-testing): `POST /v1/campaigns/{campaign_id}/ab-testing`
- [Promote an A/B winner](https://docs.versionseven.ai/api-reference/campaigns/promote-ab-winner): `POST /v1/campaigns/{campaign_id}/ab-testing/promote`
- [Get daily stats](https://docs.versionseven.ai/api-reference/campaigns/get-daily-stats): `GET /v1/campaigns/{campaign_id}/daily-stats`
- [Get the step funnel](https://docs.versionseven.ai/api-reference/campaigns/get-step-funnel): `GET /v1/campaigns/{campaign_id}/step-funnel`
- [Get the sender breakdown](https://docs.versionseven.ai/api-reference/campaigns/get-sender-breakdown): `GET /v1/campaigns/{campaign_id}/senders/breakdown`
- [Get personalization quality](https://docs.versionseven.ai/api-reference/campaigns/get-personalization-quality): `GET /v1/campaigns/{campaign_id}/personalization-quality`
- [Compare A/B cohorts](https://docs.versionseven.ai/api-reference/campaigns/get-ab-cohorts): `GET /v1/campaigns/{campaign_id}/ab-cohorts`
- [List a campaign's webhooks](https://docs.versionseven.ai/api-reference/campaigns/list-webhooks): `GET /v1/campaigns/{campaign_id}/webhooks`
- [Create a webhook](https://docs.versionseven.ai/api-reference/campaigns/create-webhook): `POST /v1/campaigns/{campaign_id}/webhooks`
- [Delete a webhook](https://docs.versionseven.ai/api-reference/campaigns/delete-webhook): `DELETE /v1/campaigns/{campaign_id}/webhooks/{webhook_id}`
- [Set or rotate a webhook secret](https://docs.versionseven.ai/api-reference/campaigns/rotate-webhook-secret): `POST /v1/campaigns/{campaign_id}/webhooks/{webhook_id}/secret`
- [Activate a webhook](https://docs.versionseven.ai/api-reference/campaigns/activate-webhook): `POST /v1/campaigns/{campaign_id}/webhook/activate` (deprecated)
- [Deactivate a webhook](https://docs.versionseven.ai/api-reference/campaigns/deactivate-webhook): `POST /v1/campaigns/{campaign_id}/webhook/deactivate` (deprecated)
- [List sequence templates](https://docs.versionseven.ai/api-reference/campaigns/list-sequence-templates): `GET /v1/campaigns/sequence-templates` (deprecated)
- [List webhook examples](https://docs.versionseven.ai/api-reference/campaigns/list-webhook-examples): `GET /v1/campaigns/webhook/examples` (deprecated)

## Pipelines

Read and update the CRM pipelines that deals move through, along with their stages.

- [List pipelines](https://docs.versionseven.ai/api-reference/crm-pipelines/list-pipelines): `GET /v1/crm/pipelines`
- [Retrieve a pipeline](https://docs.versionseven.ai/api-reference/crm-pipelines/retrieve-pipeline): `GET /v1/crm/pipelines/{pipeline_id}`
- [Update a pipeline](https://docs.versionseven.ai/api-reference/crm-pipelines/update-pipeline): `PATCH /v1/crm/pipelines/{pipeline_id}`

## Deals

Create, list, retrieve and update deals in the Victoria AI CRM.

- [List deals](https://docs.versionseven.ai/api-reference/crm-deals/list-deals): `GET /v1/crm/deals`
- [Create a deal](https://docs.versionseven.ai/api-reference/crm-deals/create-deal): `POST /v1/crm/deals`
- [Retrieve a deal](https://docs.versionseven.ai/api-reference/crm-deals/retrieve-deal): `GET /v1/crm/deals/{deal_id}`
- [Update a deal](https://docs.versionseven.ai/api-reference/crm-deals/update-deal): `PATCH /v1/crm/deals/{deal_id}`

## Reference

Blank sequence templates to start from, and example payloads for building a webhook receiver.

- [List sequence templates](https://docs.versionseven.ai/api-reference/reference/list-sequence-templates): `GET /v1/sequence-templates`
- [List webhook examples](https://docs.versionseven.ai/api-reference/reference/list-webhook-examples): `GET /v1/webhooks/examples`

## Webhook events

- [prospect_response](https://docs.versionseven.ai/api-reference/webhooks/prospect-response): Sent to a campaign's webhooks when a prospect replies.