Update Message Flow
Update an existing message flow.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
idstringrequiredThe unique identifier of the message flow to update.
Request Body
Top-level fields you send replace the stored values; fields you leave out keep their values.
settings is replaced as a whole, not merged. A settings object that only holds the key you want to change drops every other setting (response settings, email settings, knowledge bases, calendar integration and so on). Get the flow first, change what you need, and send the full settings object back with every update.
HIPAA mode is set from settings.security.securityOptOut on every update: true turns it on, and leaving it out turns it off. Send securityOptOut: true each time if the flow must stay in HIPAA mode. settings.security.hipaaCompliance is ignored.
namestringThe flow's name.
descriptionstringThe flow's description.
directionstringinbound, outbound or bidirectional.
agentstringID of the message agent the flow uses.
promptstringThe system prompt or instructions for the AI agent.
initiationMessagestringThe first message the flow sends when it starts a conversation.
messageChannelstringTwilio-SMS, Telnyx-SMS, Twilio-Email, Meta-Whatsapp, Meta-Facebook, Infobip-Whatsapp or Infobip-Facebook.
isActivebooleanWhether the flow is active.
autopilotbooleanWhether replies are sent automatically without approval.
toggleAutopilotbooleanIf true, flips autopilot to the opposite of its current value (and overrides autopilot).
settingsobjectThe flow's full settings. Send it with every update (see the warning above).
Response Fields
_idstringThe unique identifier for the message flow that was updated.
workspaceIdstringThe identifier of the workspace where the message flow is configured.
namestringThe name of the message flow.
directionstringIndicates the direction of the message flow, such as "bidirectional".
descriptionstringThe updated description of what the message flow is designed to handle.
agentstringThe ID of the message agent associated with this message flow.
settingsobjectThe configuration settings for the message flow, detailing updated and existing settings.
responseSettingsobjectSettings related to the timing and conditions under which responses are issued within the message flow.
delaynumberThe delay in seconds before a response is issued.
workingHoursobjectConfiguration for working hours during which the message flow is active.
enabledbooleanWhether working hours are enabled.
startstringStart time of the working hours.
endstringEnd time of the working hours.
timezonestringTimezone applicable to the working hours.
outOfHoursMessagestringMessage to be delivered outside of working hours.
securityobjectSecurity settings for the message flow, including HIPAA compliance status.
hipaaCompliancebooleanIndicates if HIPAA compliance is enforced.
emailSettingsobjectEmail settings for managing email-based message flows.
subjectLinestringThe subject line used for emails sent in this flow.
signaturestringThe email signature appended to messages.
promptstringThe system or initial prompt set for the AI agent in the message flow.
isActivebooleanIndicates whether the message flow is currently active.
autopilotbooleanSpecifies whether autopilot is enabled or disabled after the update.
messageChannelstringThe channel, for example Twilio-SMS.
createdAtstringThe timestamp when the message flow was created.
updatedAtstringThe timestamp when the message flow was last updated.
{
"_id": "exampleId1",
"workspaceId": "exampleWorkspaceId1",
"name": "New Years Sale",
"direction": "bidirectional",
"description": "Handles customer support inquiries via SMS",
"agent": "exampleAgentId1",
"settings": {
"responseSettings": {
"delay": 0,
"workingHours": {
"enabled": false,
"start": "0900",
"end": "1700",
"timezone": "UTC",
"outOfHoursMessage": ""
}
},
"security": {
"hipaaCompliance": false
},
"emailSettings": {
"subjectLine": "Follow Up on Your Inquiry",
"signature": "Regards"
}
},
"prompt": "You are a helpful AI that responds to user inquiries.",
"isActive": true,
"autopilot": true,
"messageChannel": "Twilio-SMS",
"createdAt": "2025-01-02T10:15:00Z",
"updatedAt": "2025-01-02T10:15:00Z"
}
Last updated on