SkipCalls Public API

Sections

Theme switcher

Delete an agent

Header Parameters

Authorizationstring

Path Parameters

idstring Required

Response

200
Object

The agent has been successfully deleted.

Response Attributes

idstring Required
namestring Required

Agent name

descriptionstring

Agent description

avatarstring

Agent avatar

isPublicboolean Required

Is agent public

isActiveboolean Required

Is agent active

instructionsstring Required

Agent instructions

incomingCallInstructionsstring Required

Agent instructions for incoming calls

maxIncomingCallDurationMinutesnumber Required

Max duration of incoming call in minutes

maxOutgoingCallDurationMinutesnumber Required

Max duration of outgoing call in minutes

gatheringInformationOnIncomingCallboolean Required

Whether the agent allows gathering information on incoming call

createdAtstring Required

Agent created at

updatedAtstring Required

Agent updated at

deletedAtstring

Agent deleted at

userIdstring Required

Creator user id

toolsarray

Agent tools

Show child attributes

accessToKnowledgeboolean

Is agent allowed to access knowledge

knowledgeAccessModestring

Knowledge access mode for the agent

Enum values:
NONEALLTAGS_ONLY
knowledgeAccessTagsarray

Tags that the agent has access to when knowledge access is tag-limited

Show child attributes

allowFollowUpsboolean

Is agent allowed to schedule follow-ups

followUpInstructionsstring

Custom instructions for smart follow-up messages

includePrivateDataboolean

Whether the user's profile info (owner name, phone, address, DOB, company) is included in the agent prompt

useBusinessProfileboolean

Whether business Q&A presets are shared with this agent in prompts

useDetachedReceptionistProfileboolean

Whether prompts should use this agent-specific represented receptionist profile

receptionistPreferredNamestring

Prompt-facing represented person, practice, or business name

receptionistCompanyNamestring

Prompt-facing represented company or business name

receptionistCompanyWebsitestring

Prompt-facing represented company website

receptionistCompanyDescriptionstring

Prompt-facing represented company description

receptionistCompanyIndustrystring

Prompt-facing represented company industry

receptionistAddressstring

Prompt-facing represented business street address

receptionistCityNamestring

Prompt-facing represented business city

receptionistStateNamestring

Prompt-facing represented business state

receptionistZipCodestring

Prompt-facing represented business ZIP/postal code

receptionistTimezonestring

Prompt-facing represented business timezone as an IANA timezone name

voicestring

Agent voice

modelNameobject

Agent model name

allowCallTransferboolean

Is agent allowed to transfer calls

callTransferNumberstring

Phone number to transfer the call to

transferHoursobject

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

Show child attributes

firstMessagestring

First message to be sent to the agent

allowOutboundGreetingInterruptionsboolean

Whether recipients can interrupt the initial greeting on outbound calls

Default value
false
enableVoiceExpressionsboolean

Whether the generated voice prompt includes provider-specific expression guidance

Default value
true
closingPhrasestring

Closing phrase the agent says before ending an inbound call

delayAcceptSecondsnumber

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

Default value
0
voiceRecognitionstring

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

Default value
EN
temperaturenumber

Temperature for the agent

dataCollectionsarray

Data collections for the agent

Show child attributes

evaluationsarray

Evaluations for the agent

Show child attributes

welcomingVoiceMailMessageForContactsstring

Welcoming voice mail message for contacts

welcomingVoiceMailMessageForOthersstring

Welcoming voice mail message for others

isVoiceMailAgentboolean

Is agent a voice mail agent

Default value
false
outgoingCallFlowallof

Flow structure for outgoing calls

Show child attributes

incomingCallFlowallof

Flow structure for incoming calls

Show child attributes

voiceSpeednumber

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

Maximum
1
Default value
0.5
incomingCallTypingSoundboolean

Typing sound for the agent

Default value
true
incomingCallBackgroundSoundboolean

Background sound for the agent

Default value
true
outgoingCallBackgroundSoundboolean

Background sound for the agent

Default value
true
outgoingCallTypingSoundboolean

Typing sound for the agent

Default value
true
allowIncomingSmsboolean

Whether the agent allows incoming SMS messages

Default value
false
incomingSmsInstructionsstring

Instructions for the agent on incoming SMS messages

autoRespondToSmsboolean

Whether the agent automatically responds to SMS messages

Default value
true
smsResponseDelaynumber

Delay in seconds before responding to SMS messages

Default value
1
useSmsIncomingCallFlowboolean

Use incoming call flow for SMS conversations (creativity slider)

Default value
false
postCallSmsMessagestring

Post-call SMS message to send after incoming calls complete

allowRealtimeSmsboolean

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

Default value
false
phoneNumbersarray

Phone numbers for the agent

Show child attributes

emailAddressallof | null

Active email receptionist address for the agent, if any

Show child attributes

requireDataConsentboolean

Whether the agent requires data consent before starting calls

Default value
false
dataConsentTextstring

Custom text/instructions for what consent is being requested for

enablePostCallActionsboolean

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

Default value
false
postCallActionInstructionsstring

Free-form instructions for post-call actions. Example: "If HVAC emergency, call John at +1234567890 immediately."

behaviorPresetstring

Behavior preset for prompt generation. Supported presets are default, employee, and lead-qualify.

Default value
default
Enum values:
defaultemployeelead-qualify
strictSpamFilterboolean

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

Default value
false
valuableCallRulestring | null

Custom rule for detecting valuable incoming calls after each call.

overrideCallerIdstring

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

404
Object

Agent not found.

Was this section helpful?

DELETE

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot