COcollectwise

Per-debtor workflow status and recent SMS

Changed on

Returns per-debtor status (paused, next stage/time), SMS counts, and recent SMS for provided debtorIds within a workflow.

post/status/debtors

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/status/debtors
  • Auth
    API key in header collectwise_key

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.

Request body

workflowIdstring required

Workflow identifier

debtorIdsstring[] required
hoursinteger
limitinteger

Response

Per-debtor statuses returned

object required

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