Update CRM Step
Updates an existing CRM step. The step ID must be provided in the request body, along with at least one other field to update. NOTE: This deviates from standard RESTful conventions where the ID is typically a path parameter.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The ID of the CRM step to update.
New name for the step.
New trigger condition or keyword for the step.
New main prompt or instruction for the step.
New initial message for the step.
New ID of the step to automatically transition to. Use null to remove.
New time in seconds for auto-transition. Use null to remove.
New default status for conversations at this step.
RESOLVED, UNRESOLVED, HUMAN_REQUESTED New default priority for conversations at this step.
LOW, MEDIUM, HIGH New logic for assigning conversations at this step.
none, clear, single_user, random_selected, fair_distribution_selected New list of membership IDs for assignee logic.
New mandatory status for the step.
New Agent ID to associate with this step. Use null to remove.
New time unit for auto-transition.
m, h, d New default tags to add to the conversation.
New default tags to remove from the conversation.
New configuration for requesting contact information.
New value for conversation removal step flag.
Z-API integration settings.
WhatsApp template integration settings.
New default AI control setting for the conversation.
New URL for the webhook to be called.
New headers for the webhook request.
Response
The unique identifier for the CRM step.
The name of the CRM step.
The order/index of the step within its scenario.
The main prompt or instruction for this step.
A trigger condition or keyword for this step.
An initial message to be sent when this step is activated.
ID of the step to automatically transition to after this one.
Time in seconds to wait before automatically transitioning to autoNextStepId.
The time unit for auto-transition.
m, h, d Default status to set for conversations reaching this step.
RESOLVED, UNRESOLVED, HUMAN_REQUESTED Default priority to set for conversations reaching this step.
LOW, MEDIUM, HIGH Default AI control setting for the conversation.
Logic for assigning conversations at this step.
none, clear, single_user, random_selected, fair_distribution_selected List of membership IDs for assignee logic.
Indicates if this step is mandatory.
If true, this step removes the conversation from the scenario.
Default tags to add to the conversation.
Default tags to remove from the conversation.
Configuration for requesting contact information.
Z-API integration settings.
WhatsApp template integration settings.
URL for the webhook to be called.
Headers for the webhook request.
Timestamp of when the step was created.
Timestamp of when the step was last updated.
Was this page helpful?