# Versioning and deprecation

How the Victoria AI API is versioned, how deprecated endpoints are announced, and where to get the OpenAPI specification.

## Versions

The version is part of every path: all endpoints live under `https://api.versionseven.ai/v1`.

Build your integration to ignore response fields it doesn't use, so it keeps working as fields are added.

## Deprecated endpoints

When an endpoint is replaced, the original keeps working and is marked deprecated in three ways:

- The OpenAPI specification sets `deprecated: true` on it.
- Its responses carry the header `Deprecation: true`.
- Its responses carry a `Link` header naming the replacement, for example `Link: </v1/leads>; rel="successor-version"`.

A `Sunset` header will announce the date a deprecated endpoint stops working, once a date is chosen. No endpoint has a sunset date today.

| Deprecated endpoint | Use instead |
| - | - |
| [`POST /v1/leads/create`](https://docs.versionseven.ai/api-reference/leads/create-standalone-lead) | [`POST /v1/leads`](https://docs.versionseven.ai/api-reference/leads/create-lead) |
| [`POST /v1/campaigns/{campaign_id}/webhook/activate`](https://docs.versionseven.ai/api-reference/campaigns/activate-webhook) | [`POST /v1/campaigns/{campaign_id}/webhooks`](https://docs.versionseven.ai/api-reference/campaigns/create-webhook) |
| [`POST /v1/campaigns/{campaign_id}/webhook/deactivate`](https://docs.versionseven.ai/api-reference/campaigns/deactivate-webhook) | [`DELETE /v1/campaigns/{campaign_id}/webhooks/{webhook_id}`](https://docs.versionseven.ai/api-reference/campaigns/delete-webhook) |
| [`GET /v1/campaigns/sequence-templates`](https://docs.versionseven.ai/api-reference/campaigns/list-sequence-templates) | [`GET /v1/sequence-templates`](https://docs.versionseven.ai/api-reference/reference/list-sequence-templates) |
| [`GET /v1/campaigns/webhook/examples`](https://docs.versionseven.ai/api-reference/campaigns/list-webhook-examples) | [`GET /v1/webhooks/examples`](https://docs.versionseven.ai/api-reference/reference/list-webhook-examples) |

## OpenAPI specification

The full specification is public, and this reference is generated from it:

- JSON: <https://api.versionseven.ai/openapi.json>
- YAML: <https://api.versionseven.ai/openapi.yaml>

Use it to generate a client, or to import the API into a tool such as Postman.