Updates an existing action's configuration. This includes modifying the action name, description, trigger conditions, and behavior settings.

http
PUT https://services.leadconnectorhq.com/conversation-ai/agents/{agentId}/actions/{actionId}

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
actionIdstringYesThe unique identifier of the action ID Attached to the agent
agentIdstringYes

Body

NameTypeRequiredExampleDescription
typestringYestriggerWorkflowPossible values: 'triggerWorkflow', 'updateContactField', 'appointmentBooking', 'stopBot', 'humanHandOver', 'advancedFollowup', 'transferBot'
namestringYesTrigger a Workflow
detailsobjectYesAction-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and for TRANSFER_BOT use transferBotDto.

Responses

200 - Successful response
  • data (object, required): Updated action details

  • success (boolean, required): Success status of the request Example: True

json
{
  "success": true
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}

Example

curl -X PUT 'https://services.leadconnectorhq.com/conversation-ai/agents/YOUR_agentId/actions/YOUR_actionId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "triggerWorkflow",
  "name": "Trigger a Workflow"
}'

Last updated October 26, 2026

Was this page helpful?