Update an AI field

PATCH/v1/campaigns/{campaign_id}/ai-fields/{field_id}

Scope: campaigns:write

Updates the fields you send and leaves the rest unchanged. field_name can't be changed; create a new field instead. ai_instructions and fallback_value can't be set blank. Set is_active: false to stop generating the field for new leads; there's no delete.

Headers

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

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.
field_idstring · uuidRequired
ID of the field.

Request body

ai_instructionsstring or null
at most 4,000 characters
data_sourcesarray of strings or null
fallback_valuestring or null
at most 300 characters
field_descriptionstring or null
at most 500 characters
is_activeboolean or null

Response

200

messagestringRequired
ai_fieldobject or null
A per-lead variable a model writes before each message, e.g. {recent_post}.
Show 9 child attributesHide child attributes
- idstringRequired
- field_namestringRequired
  The variable's name, used as {field_name} in step copy.
- ai_instructionsstringRequired
  What to write for each lead, and from what.
- created_atstring · date-time or null
- data_sourcesarray of strings or null
  Where each lead is researched: linkedin, website or both.
- fallback_valuestring or null
  What a lead gets when personalization fails, so its message still reads well.
- field_descriptionstring or null
- is_activeboolean
  Only active fields are generated. Set false to stop using a field; there's no delete.
  Default true
- 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	AI_FIELD_NOT_FOUND	No AI field with this ID exists on the campaign.
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.