Update Action

PUT 
/conversation-ai/agents/:agentId/actions/:actionId

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

Request

Version stringrequired

API Version

Available optionsv3

actionId stringrequired

The unique identifier of the action ID Attached to the agent

agentId stringrequired

application/json

application/json

Body

Bodyrequired

typestringrequired
Available optionstriggerWorkflowupdateContactFieldappointmentBookingstopBothumanHandOveradvancedFollowuptransferBot
namestringrequired
detailsobjectrequired

Action-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.

Example (auto)

{
  "type": "triggerWorkflow",
  "name": "Trigger a Workflow",
  "details": {
    "workflowIds": [
      "workflow123",
      "workflow456"
    ],
    "triggerCondition": "When user requests appointment",
    "triggerMessage": "Workflow triggered successfully"
  }
}

application/json

Successful response

application/json

Schema

Schema

dataobjectrequired

Updated action details

successbooleanrequired

Success status of the request

Example (auto)

{
  "data": {
    "id": "actionId123",
    "name": "Trigger Workflow",
    "type": "triggerWorkflow",
    "agentId": "agentId123",
    "details": {
      "workflowIds": [
        "workflow123",
        "workflow456"
      ],
      "triggerCondition": "When user requests appointment",
      "triggerMessage": "Workflow triggered successfully"
    }
  },
  "success": true
}