Skip to main content

RefusalReasonCreateRequest

Payload to create a manual refusal reason for an agent.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

display_nameDisplay Namerequired

Human-readable refusal reason. The backend derives the stable key from this value.

Possible values: non-empty and <= 80 characters

descriptionDescription

Guidance for when this refusal reason should be used.

Default value:
examplesstring[]

Short example user refusals that fit this reason.

is_activeIs Active

Whether the reason is immediately available to the classifier.

Default value: true
movement_type object
anyOf
SystemMovementType

Kind of a technical, non-conversational lead stage movement. Used as a neutral signal through the movement pipeline; transformed into the agent's designated refusal reason (RefusalReason.movement_type) downstream. None = conversational.

Possible values: [ignore, total_ignore, outreach_failure, delivery_failure, invalid_contact, blocked_contact, blacklisted_contact]

RefusalReasonCreateRequest
{
  "agent_id": 0,
  "display_name": "string",
  "description": "",
  "examples": [
    "string"
  ],
  "is_active": true,
  "movement_type": "ignore"
}