Replace agent configuration
Replaces the complete writable agent configuration using the same relaxed, defaulted schema as agent creation. No phone number or voice is inferred from the organization. Omitted fields return to their schema defaults, supplied arrays replace existing arrays, empty arrays clear them, and null clears nullable fields. Use PATCH instead when changing only name, phoneNumbers, or webhooks. Lifecycle state is preserved unless the agent is changed to a trigger agent, which activates immediately. Ownership, audit, generated credentials, and provider-managed fields are preserved by the server.
Authorizations
Headers
Optional sub organization ID. Must belong to your main organization API key.
Path Parameters
ID of the agent to replace
^[0-9a-fA-F]{24}$Body
Human-readable campaign name. Minimum 3 characters.
32000Legacy flat script steps. Use this or nestedSteps; omitted scripts receive the standard starter step.
Hierarchical script nodes containing prompts, actions, transfers, forms, and meetings.
Directed graph edges connecting script and nested-script nodes.
Fallback behavior for silence, errors, retries, and unhandled input.
Interest classification criteria. Include a non-empty value when defining a custom criterion.
Whether interactions are initiated by the customer. Defaults to false.
Typed script variables. Omit to receive direction-aware defaults.
1 < x < 20Call, speech, scheduling, retry, recording, voicemail, web-call, and model settings. Nested fields use the same defaults as the UI.
Chat channel, sender numbers, cadence, and drop-off configuration.
Email connections, sender behavior, follow-up cadence, content, and signature configuration.
Post-interaction summary questions. Each question requires a non-empty name; description and options are optional.
Callable HTTP or integration actions available during an interaction. Every function definition and every parameter property must include a non-empty description. External tools require apiData; ActivePieces tools require activePieceData.
Trigger definitions used by trigger and event-driven campaigns.
Actions run before an outbound call. ActivePieces actions require their activePieceAction configuration.
Knowledge bases available to the campaign. IDs must belong to the authenticated organization.
Optional campaign group ID from the authenticated organization.
^[0-9a-fA-F]{24}$ROTATE_NUMBERS, PREFER_LOCAL_NUMBERS, AUTO_OPTIMIZE Campaign channel: CALL, CHAT, EMAIL, or TRIGGER. Defaults to CALL.
CALL, CHAT, TRIGGER, EMAIL 50 < x < 1000Convenience alias for callParams.voice. When supplied, this value takes precedence.
^[0-9a-fA-F]{24}$Convenience alias for callParams.phonesFrom. When supplied, this list takes precedence; an empty list clears assigned call numbers.
^[0-9a-fA-F]{24}$