COcollectwise

Pause a debtor's workflow

Changed on

Pauses the active workflow for the specified debtor, suppressing outbound communications.

patch/workflow/{debtorId}/pause

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/workflow/{debtorId}/pause
  • Auth
    API key in header collectwise_key

Path parameters

debtorIdstring required

Unique identifier of the debtor

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Workflow paused successfully

messagestring
pausedboolean

Example response

{
  "message": "Debtor's workflow paused",
  "paused": true
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status