How To Use The Rest API End Point - Contact Plans

Use this end-point to run Contact Plans on account. Contact Plans can be run on Clients, Debtors, Cosigners, and Associates.

Contact plans that stop and prompt the user for information will require a Web Socket ID passed in the 'websocket-id' field of the request body. If you are unsure about whether the plan has prompting, then it is best practice to always open a Web Socket connection. Please refer to the Help topic How To Use The Rest API for information on Web Sockets.

Useful Note Contact plans that require a Web Socket are those with the 'Prompt for start date' or 'Prompt before deleting' switch turned on or with events that have 'Prompt to confirm details' switch turned on.

Useful Note If the plan needs to use a Web Socket, and fails to do so, the plan will fail. Any changes made to the database by the plan, up to that point, will be rolled back.

POST Type End-Point

/api/v1/collect/app/runplan

Request Body

{
  "plan": "{plan}",
  "{record}": {rowid},
  "websocket-id": "{websocket-id}"
}

Code	Description
plan	This is the Code for the Contact Plan to run. In the database, it is the value in the cp_code field in the contact_plan table.
record	This is the record to run the Contact Plan on. The currently supported values are: debtor client cosigner associate
rowid	This is the database rowid for the applicable record.
websocket-id	This is the web socket ID for the applicable socket connection.

Examples

Useful Note Contact Plans only work for Debtors, Clients, Cosigners, and Associates.

{
  "plan": "REV",
  "debtor": 123,
  "websocket-id": "43tzLWO2RJzlxQPpsw4EOA=="
}

Response Body

At present, there is no Response Body for Contact Plans.

Was this page helpful? Do you have any comments on this document? Can we make it better? If so how may we improve this page.

Please click this link to send us your comments: helpinfo@collect.org