Skip to main content

RefusalReasonUpdateRequest

Partial update for a refusal reason. At least one field must be provided.

display_name object

New human-readable refusal reason. The backend recalculates the stable key from this value.

anyOf
string

Possible values: non-empty and <= 80 characters

description object

Updated guidance for when this refusal reason should be used.

anyOf
string
examples object

Updated example user refusals that fit this reason.

anyOf
  • Array [
  • string
  • ]
  • is_active object

    Whether the classifier can currently choose this reason.

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

    RefusalReasonUpdateRequest
    {
    "display_name": "string",
    "description": "string",
    "examples": [
    "string"
    ],
    "is_active": true,
    "movement_type": "ignore"
    }