WHwhispa
accounts

Release Account Hold

Clear the hold that stops every automatic call to an account (admin only).

Records who cleared it, when, and what the hold was. Campaign memberships the hold closed stay as they are; resume them from the campaign or the review queue. A creditor file feed's hold cannot be cleared here (409).

post/accounts/{account_id}/release-hold

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Path parameters

account_idstring uuid required

Response

Successful Response

idstring uuid required
providerstring required
external_idstring required
display_namestring required
account_numberstring nullable
emailstring nullable
addressstring nullable
dobstring date nullable
customer_idstring nullable
client_idstring nullable
phonestring nullable
phonesstring[]
statestring nullable
timezonestring nullable
manual_timezonestring nullable
manual_timezone_set_bystring uuid nullable
manual_timezone_set_by_emailstring nullable
manual_timezone_set_atstring date-time nullable
statusstring nullable
balancenumber nullable
arrears_amountnumber nullable
original_balancenumber nullable
amount_paidnumber nullable
collection_stagestring nullable
data_source'crm' | 'csv'
source_filenamestring nullable
source_dataobject nullable
suppression_reasonstring nullable
suppressed_atstring date-time nullable
suppression_released_reasonstring nullable
suppression_released_bystring uuid nullable
suppression_released_by_emailstring nullable
suppression_released_atstring date-time nullable
synced_atstring date-time required
created_atstring date-time required
updated_atstring date-time required
suppression_releasableboolean required

Whether an operator may clear the hold: a creditor file's is the file's to lift.

Changes

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