PUT
/
agents
/
update
curl --request PUT \
  --url https://svalync.com/api/agents/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "name": "<string>",
  "welcomeMessage": "<string>",
  "task": "<string>",
  "voice": "<string>",
  "language": "<string>",
  "telephonyProvider": "<string>",
  "callTermination": 123,
  "hangupMessage": "<string>"
}'
{
  "response": [
    {
      "success": true,
      "data": {
        "id": "<string>",
        "name": "<string>",
        "welcomeMessage": "<string>",
        "task": "<string>",
        "voice": "<string>",
        "language": "<string>",
        "telephonyProvider": "<string>",
        "callTermination": 123,
        "hangupMessage": "<string>",
        "apiTool": "<any>",
        "knowledgeBase": "<string>",
        "workflow": "<string>"
      }
    }
  ]
}

Authorization

x-api-key
string
required

Your Api Key

Params

id
string
required

The unique id for the agent being updated.

Body

name
string
required

The name of the agent to be created.

welcomeMessage
string
required

The welcome message to be delivered by the agent.

task
string
required

The specific task the agent is responsible for.

voice
string
required

The voice to be used by the agent for communication.

language
string
required

The language the agent will use for communication.

telephonyProvider
string
required

The telephony provider to be used for the agent’s calls.

callTermination
number
required

The conditions under which the call will be terminated in seconds.

hangupMessage
string
required

The message to be delivered when the call is terminated.

Response

response
array