Agents

Update an agent

Update an agent.

PATCH

/business/locations/{location_id}/agents/{id}

Update an agent

curl --request PATCH \
  --url https://api-example.kickcall.ai/api/v1/business/locations/{location_id}/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": {
    "enable_welcome_message": true,
    "knowledgebasis_ids": [
      123
    ],
    "languages": [
      "<string>"
    ],
    "name": "<string>",
    "response_engine": "<string>",
    "voice_id": "<string>",
    "welcome_message": "<string>"
  }
}
'

{
  "created_at": "2025-07-10T12:00:00.000Z",
  "id": 980,
  "location_id": 340,
  "location_name": "Downtown",
  "name": "Alex",
  "phone_number": "+14165550111",
  "response_engine": "conversation_flow",
  "telephony_assignments": [],
  "updated_at": "2026-01-15T09:30:00.000Z",
  "voice_id": "voice_abc",
  "welcome_message": "Thanks for calling Acme Dental."
}

Audience: Business portal. Auth: Business/agency JWT or API key; usually header Business-Id. Resource: Agents.

Authorizations

Authorizationstringheaderrequired

JWT from OTP login, or business/agency API key string.

Path Parameters

location_idintegerrequired

idintegerrequired

Body

agentobjectrequired

Show child attributes

Response

OK — Updated agent

created_atstring

idinteger

location_idinteger

namestring

phone_numberstring | null

response_enginestring

updated_atstring

voice_idstring | null

welcome_messagestring | null

Still need help? Ask the team