AgentsUpdate agent

Update agent

Updates whitelisted agent configuration. All fields are optional and only provided fields are changed. For companyInfo, persona, autonomousMode, and followupSettings, provided fields are merged into the existing object.

Calendar settings and selected page controls are not accepted by the public API.

curl -X PATCH "https://api.sendkit.ai/v1/agents/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "name": "Enterprise Sales Agent v2"
}'
{
  "success": true,
  "data": {
    "_id": "664a1b2c3d4e5f6a7b8c9d0e",
    "name": "Enterprise Sales Agent v2",
    "userId": "user_123",
    "workspaceId": "ws_123",
    "companyInfo": {
      "name": "Acme Inc",
      "description": "AI-powered email outreach platform with 10k+ customers"
    },
    "persona": {
      "tone": "friendly",
      "role": "sales representative",
      "communicationStyle": "concise",
      "customInstructions": "Always ask about their current tooling."
    },
    "isDefault": true,
    "isActive": true,
    "createdAt": "2024-06-01T10:00:00.000Z",
    "updatedAt": "2024-06-05T14:30:00.000Z"
  }
}
PATCH
/v1/agents/{agentId}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring

Agent name (trimmed)

companyInfoobject

Fields to merge into company info

companyUrlstring

Company website URL or domain used for future retraining

personaobject

Fields to merge into persona

isDefaultboolean

Set or unset this agent as the workspace default

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

Body

application/json
namestring

Agent name (trimmed)

companyInfoobject

Fields to merge into company info

companyUrlstring

Company website URL or domain used for future retraining

personaobject

Fields to merge into persona

followupSettingsobject
isDefaultboolean

Set or unset this agent as the workspace default

Responses

successboolean
dataobject