DELETE
/
crm
/
step

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string
required

The ID of the CRM step to delete.

Response

200 - application/json
id
string

The unique identifier for the CRM step.

index
integer

The order/index of the step within its scenario.

prompt
string | null

The main prompt or instruction for this step.

trigger
string | null

A trigger condition or keyword for this step.

initialMessage
string | null

An initial message to be sent when this step is activated.

autoNextStepId
string | null

ID of the step to automatically transition to after this one.

autoNextTime
integer | null

Time in seconds to wait before automatically transitioning to autoNextStepId.

defaultStatus
enum<string> | null

Default status to set for conversations reaching this step.

Available options:
RESOLVED,
UNRESOLVED,
HUMAN_REQUESTED
defaultPriority
enum<string> | null

Default priority to set for conversations reaching this step.

Available options:
LOW,
MEDIUM,
HIGH
defaultAssigneeId
string | null

Default user ID to assign conversations reaching this step.

shouldAssignRandomUser
boolean | null

If true, assigns a random user from the organization if defaultAssigneeId is not set.

isRequired
boolean | null

Indicates if this step is mandatory.

organizationId
string
agentId
string | null
scenarioId
string
createdAt
string

Timestamp of when the step was created.

updatedAt
string

Timestamp of when the step was last updated.

agent
object | null
scenario
object

Was this page helpful?

Update CRM StepAdd Conversation to CRM Step