Skip to main content

RefusalReasonRead

A reusable agent-scoped reason explaining why a lead refused or was moved to a refusal outcome stage. Active non-system rows are offered to the classifier as options; inactive rows are retained for reporting history.

idIdrequired

Unique numeric identifier of the record.

agent_idAgent Idrequired

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

keyKeyrequired

Stable normalized identifier derived from the display name.

display_nameDisplay Namerequired

Human-readable refusal reason shown in settings and analytics.

descriptionDescriptionrequired

Guidance for when this refusal reason should be used.

examplesstring[]required

Short example user refusals that fit this reason.

sourceRefusalReasonSourcerequired

Whether the reason was created manually, provisioned as a preset, proposed by the LLM, or reserved by the system.

Possible values: [manual, preset, llm, system, import]

is_activeIs Activerequired

Whether the classifier can currently choose this reason.

crm_integration_id object
anyOf
integer
crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf
string
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]

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

RefusalReasonRead
{
  "id": 0,
  "agent_id": 0,
  "key": "string",
  "display_name": "string",
  "description": "string",
  "examples": [
    "string"
  ],
  "source": "manual",
  "is_active": true,
  "crm_integration_id": 0,
  "crm_id": "string",
  "movement_type": "ignore",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}