Update an agent

patch

https://be.skipcalls.com/agents/{id}

Partial update — only fields sent in the body are changed. If instructions change they're re-validated and rejected if invalid. If toolIds is sent, ALL existing tool links are replaced. SMS-capable setting changes reconcile Messaging Service registration for assigned US Twilio numbers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

name

string

description

string

avatar

string

isPublic

boolean

isActive

boolean

instructions

string

toolIds

array of strings

toolIds

modelName

string

enum

Defaults to gemini-3-flash-preview

Model to use for the agent

Allowed:

voice

string

Voice to use for the agent

voiceSpeed

number

0 to 1

Defaults to 0.5

Voice pace from slow to fast. 0.5 is normal/provider default. Not all voice providers support speed control.

accessToKnowledge

boolean

Defaults to false

Whether the agent has access to knowledge

knowledgeAccessMode

string

enum

Defaults to NONE

Knowledge access mode for the agent

Allowed:

knowledgeAccessTags

array of strings

Defaults to []

Tags that the agent has access to (only used when knowledgeAccessMode is TAGS_ONLY)

knowledgeAccessTags

includePrivateData

boolean

Defaults to true

Include the user's profile info (owner name, phone, address, DOB, company) in the agent prompt.

useBusinessProfile

boolean

Defaults to true

Include business Q&A presets (hours, pricing, services) from /business-profile in the agent prompt

useDetachedReceptionistProfile

boolean

Defaults to false

Use per-agent receptionist profile fields in prompts instead of only the account profile

receptionistPreferredName

string

Prompt-facing represented person, practice, or business name

receptionistCompanyName

string

Prompt-facing represented company or business name

receptionistCompanyWebsite

string

Prompt-facing represented company website

receptionistCompanyDescription

string

Prompt-facing represented company description

receptionistCompanyIndustry

string

Prompt-facing represented company industry

receptionistAddress

string

Prompt-facing represented business street address

receptionistCityName

string

Prompt-facing represented business city

receptionistStateName

string

Prompt-facing represented business state

receptionistZipCode

string

Prompt-facing represented business ZIP/postal code

receptionistTimezone

string

Prompt-facing represented business timezone as an IANA timezone name

allowCallTransfer

boolean

Defaults to false

Whether the agent allows call transfer

callTransferNumber

string

Number to transfer the call to

transferHours

object

Work hours for call transfer in HHMM format (e.g., {"MONDAY": [900, 1730]}). If null, transfer is always allowed.

firstMessage

string

First message to send from the agent

allowOutboundGreetingInterruptions

boolean

Defaults to false

Whether recipients can interrupt the initial greeting on outbound calls

enableVoiceExpressions

boolean

Defaults to true

Whether the generated voice prompt includes provider-specific expression guidance

closingPhrase

string

Closing phrase the agent says before ending an inbound call

delayAcceptSeconds

number

0 to 20

Defaults to 0

Seconds to wait before the voice agent joins an inbound call.

voiceRecognition

string

enum

Defaults to EN

Voice recognition mode: EN for English-only (highest accuracy), MULTI for multilingual support

Allowed:

allowFollowUps

boolean

Defaults to false

Whether the agent allows follow-ups

followUpInstructions

string

Custom instructions for smart follow-up messages. When provided, the AI uses these to guide follow-up content.

gatheringInformationOnIncomingCall

boolean

Defaults to false

Whether the agent allows gathering information on incoming call

maxIncomingCallDurationMinutes

number

Defaults to 3

Max duration of incoming call in minutes

maxOutgoingCallDurationMinutes

number

Defaults to 10

Max duration of outgoing call in minutes

incomingCallInstructions

string

Instructions for the agent on incoming calls

welcomingVoiceMailMessageForContacts

string

Welcoming voice mail message for contacts

welcomingVoiceMailMessageForOthers

string

Welcoming voice mail message for others

isVoiceMailAgent

boolean

Defaults to false

Is agent a voice mail agent

outgoingCallFlow

object

Flow structure for outgoing calls

incomingCallFlow

object

Flow structure for incoming calls

incomingCallTypingSound

boolean

Defaults to true

Whether the agent has a typing sound for incoming calls

incomingCallBackgroundSound

boolean

Defaults to true

Whether the agent has a background sound for incoming calls

outgoingCallTypingSound

boolean

Defaults to true

Whether the agent has a typing sound for outgoing calls

outgoingCallBackgroundSound

boolean

Defaults to true

Whether the agent has a background sound for outgoing calls

allowIncomingSms

boolean

Defaults to false

Whether the agent allows incoming SMS messages

incomingSmsInstructions

string

Instructions for the agent on incoming SMS messages

autoRespondToSms

boolean

Defaults to true

Whether the agent automatically responds to SMS messages

smsResponseDelay

number

Defaults to 1

Delay in seconds before responding to SMS messages

useSmsIncomingCallFlow

boolean

Defaults to false

Use incoming call flow for SMS conversations (creativity slider)

postCallSmsMessage

string

Post-call SMS message to send after incoming calls complete

allowRealtimeSms

boolean

Defaults to false

Whether the agent can send SMS messages during calls via the send_sms tool

requireDataConsent

boolean

Defaults to false

Whether the agent requires data consent before starting calls

dataConsentText

string

Custom text/instructions for what consent is being requested for

enablePostCallActions

boolean

Defaults to false

Whether to enable post-call outbound actions (scheduling calls after incoming calls)

postCallActionInstructions

string

Free-form instructions for post-call actions. Example: "If HVAC emergency, call John at +1234567890 immediately. If plumbing issue, call Mike at +1555555555 in 5 minutes."

behaviorPreset

string

enum

Defaults to employee

Behavior preset for normal agent create/update. New agents are currently created as employee; lead-qualify is manual/admin-only.

Allowed:

strictSpamFilter

boolean

Defaults to false

Strictly reject incoming calls detected as spam before connecting to the agent

valuableCallRule

string | null

Custom rule for detecting valuable incoming calls after each call. Max 300 characters.

overrideCallerId

string | null

UUID of a verified caller ID to use for outbound calls. Null to clear.

Responses

404

Agent not found.

200The agent has been successfully updated.

400Invalid agent instructions