Update SmartBuddy
Overview
Update a SmartBuddy and its associated reference entries.
Endpoint
PUT /api/smartbuddy/update
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
id | integer | Required | SmartBuddy ID. |
isPwdNull | boolean | See notes | Password-handling flag. Confirm its effect before changing it. |
UserId | integer | See notes | User associated with the Buddy. |
StationId | integer | See notes | Station associated with the Buddy. |
Name | string | See notes | Updated Buddy name. |
DomainUser | string | See notes | Domain account. URL-encode the backslash. |
Description | string | See notes | Updated description. URL-encode spaces. |
IsEnabled | boolean | See notes | Whether the Buddy is enabled. |
The example supplies all parameters listed above. Omission behavior and server defaults are not established by this reference; confirm them for your deployed version.
Request body
| Parameter | Type | Requirement | Description |
|---|---|---|---|
id | integer | See notes | ID of the resource to update or retrieve. |
typeId | integer | See notes | Reference entry field. Confirm supported values for your deployment. |
referenceId | integer | See notes | Reference entry field. Confirm supported values for your deployment. |
Types reflect the example below. Unless marked required, field requirements, defaults, and validation limits need confirmation for your deployed version.
[
{
"id": 0,
"typeId": 0,
"referenceId": 0
}
]
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request PUT \
--url 'https://command-center.example.com/api/smartbuddy/update?id=3&isPwdNull=true&UserId=2&StationId=3&Name=example-buddy&DomainUser=EXAMPLE%5Csample-user&Description=Example%20Buddy&IsEnabled=true' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '[
{
"id": 0,
"typeId": 0,
"referenceId": 0
}
]'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
[]
The body is an array of reference entries (id, typeId, and referenceId). The existing example does not establish their mapping or whether an empty array clears associations. Confirm this before updating a Buddy.
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.