Skip to main content
PATCH
/
public
/
v1
/
agents
/
{agentId}
Update agent
curl --request PATCH \
  --url https://api.callin.io/api/public/v1/agents/{agentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "success": true,
  "data": {
    "agentId": "<string>",
    "name": "<string>",
    "direction": "outbound",
    "tags": [
      "<string>"
    ],
    "platformSettings": {
      "callActions": {
        "smartOptOut": false,
        "issueTracking": false,
        "postCallWebhook": "<string>",
        "postCallEmail": {
          "enabled": false,
          "emailConfiguration": {}
        },
        "scheduleOnCalendar": {
          "enabled": false,
          "provider": "google",
          "eventsIds": [
            "<string>"
          ]
        }
      },
      "widget": {},
      "dataCollection": {
        "entities": {},
        "storeData": false
      },
      "callRetry": {
        "retryCount": 123,
        "retryDelay": 123
      },
      "summaryLanguage": "<string>",
      "privacy": {
        "recordVoice": false
      },
      "telephony": {
        "numberRotationEnabled": false,
        "rotationNumbers": [
          "<string>"
        ],
        "callsPerNumber": 123,
        "stateRestrictionEnabled": false,
        "stateRestrictedNumbers": [
          "<string>"
        ]
      }
    },
    "phoneNumbers": [
      {
        "provider": "<string>",
        "number": "<string>",
        "label": "<string>"
      }
    ],
    "workflow": {
      "edges": {},
      "nodes": {},
      "preventSubagentLoops": false
    },
    "metadata": {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": {
        "userId": "<string>",
        "userEmail": "<string>"
      }
    }
  }
}

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Path Parameters

agentId
string
required

The unique identifier of the agent to update.

Body

application/json

Partial update payload for an agent. All fields are optional — include only the fields you want to change. Omitted fields remain unchanged.

name
string

Display name for the agent.

direction
enum<string>

Supported call direction.

Available options:
outbound,
inbound,
both
tags
string[]

Tags for organizing agents.

conversationConfig
object
platformSettings
object

Platform settings fields to update. Only include fields you want to change.

Response

Agent updated successfully. Returns the full updated agent.

Full single-agent record including conversation and platform configuration.

success
boolean
Example:

true

data
object