Update the reply agent

PATCH/v1/campaigns/{campaign_id}/responder

Scope: campaigns:write

Updates the fields you send and leaves the rest unchanged. When the campaign has no configuration yet, one is created for the current agent, answering on its own, with is_enabled: false unless you send it.

goal_link must be an https URL. Each entry in assets is a link (https) with a description of when to share it. tone is friendly, direct or formal. campaign_description, custom_instructions, company_name and agent_name are limited to 8,000 characters each.

is_enabled also sets the campaign's responder_enabled flag, the one Update a campaign changes, so the two never disagree.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Request body

agent_namestring or null
at most 100 characters
assetsarray of objects or null
Links the agent may share, e.g. a walkthrough video
Show 2 child attributesHide child attributes
- descriptionstringRequired
  When to share the link, in a sentence the agent can act on.
  at most 300 characters
- linkstringRequired
  https:// URL
  at most 2,000 characters
campaign_descriptionstring or null
at most 8,000 characters
company_namestring or null
at most 200 characters
custom_instructionsstring or null
at most 8,000 characters
goal_linkstring or null
Where the agent sends an interested prospect, e.g. a booking page
at most 2,000 characters
is_enabledboolean or null
Answer replies automatically
tonestring or null
One of"friendly""direct""formal"

Response

200

campaign_idstring or null
messagestring or null
responderobject or null
Show 16 child attributesHide child attributes
- agent_namestring or null
- agent_versioninteger or null
  2 is the current agent. Configurations created through the API are always version 2.
- assetsarray of objects or null
  Links the agent may share, each with a link and a description of when to share it.
- campaign_descriptionstring or null
- campaign_idstring or null
- company_namestring or null
- custom_instructionsstring or null
- first_message_modestring or null
- goalstring or null
- goal_linkstring or null
  Where the agent sends an interested prospect, such as a booking page.
- idstring or null
- is_enabledboolean or null
  Whether the agent answers replies. Mirrors the campaign's responder_enabled.
- max_repliesinteger or null
- modestring or null
- tonestring or null
  friendly, direct or formal.
- updated_atstring · date-time or null
successboolean
Default true

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
400	VALIDATION_ERROR	The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`.
400	NO_UPDATES	The update request contained no fields to change.
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
413	PAYLOAD_TOO_LARGE	The request body is larger than 1 MB.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.

Request

curl -X PATCH "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/responder" \
  -H "Authorization: Bearer $VICTORIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_enabled": true,
  "goal_link": "https://calendly.com/acme/intro",
  "tone": "direct",
  "custom_instructions": "Offer a 20-minute intro call. If they ask for pricing, say it starts at $99 a month and offer the call for details.",
  "assets": [
    {
      "link": "https://www.example.com/walkthrough",
      "description": "A 3-minute product walkthrough, for anyone who asks how it works"
    }
  ]
}'

const response = await fetch("https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/responder", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.VICTORIA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "is_enabled": true,
    "goal_link": "https://calendly.com/acme/intro",
    "tone": "direct",
    "custom_instructions": "Offer a 20-minute intro call. If they ask for pricing, say it starts at $99 a month and offer the call for details.",
    "assets": [
      {
        "link": "https://www.example.com/walkthrough",
        "description": "A 3-minute product walkthrough, for anyone who asks how it works"
      }
    ]
  }),
});

const data = await response.json();

import os

import requests

response = requests.patch(
    "https://api.versionseven.ai/v1/campaigns/550e8400-e29b-41d4-a716-446655440000/responder",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
    json={
        "is_enabled": True,
        "goal_link": "https://calendly.com/acme/intro",
        "tone": "direct",
        "custom_instructions": "Offer a 20-minute intro call. If they ask for pricing, say it starts at $99 a month and offer the call for details.",
        "assets": [
            {
                "link": "https://www.example.com/walkthrough",
                "description": "A 3-minute product walkthrough, for anyone who asks how it works",
            },
        ],
    },
)
data = response.json()

Response

{
  "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "string",
  "responder": {
    "agent_name": "string",
    "agent_version": 1,
    "assets": [
      {}
    ],
    "campaign_description": "string",
    "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
    "company_name": "string",
    "custom_instructions": "string",
    "first_message_mode": "string",
    "goal": "string",
    "goal_link": "string",
    "id": "a5614527-0ce6-43be-bd1d-d012b7394867",
    "is_enabled": true,
    "max_replies": 1,
    "mode": "string",
    "tone": "string",
    "updated_at": "2026-01-14T19:30:00+00:00"
  },
  "success": true
}