dunning-states

Create a Dunning State

Create a Dunning State

post/v2/dunning-states

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring required
action'outreach_pause' | 'outreach_enable' required

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

Unique per org, display name for the state (e.g. 'Dunning', '3rd party collection')

descriptionstring required

Short user facing description

action'outreach_pause' | 'outreach_enable' required
is_dispute_defaultboolean required

Whether a partner is switched to this state when a customer-level dispute pause is activated. At most one per organization; must be an OUTREACH_PAUSE state.

objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.