Skip to main content

Request a stipulation sync for a creditor application

Runs your StipulationSync script against this application and applies the stipulation changes it returns. The run is asynchronous, so a 204 means the request was accepted, not that the stipulations have already changed. The application must already have been submitted to you. If you have no published StipulationSync script the run is recorded as skipped and nothing changes.

Path Parameters
applicationId string — REQUIRED
creditorId string — REQUIRED
Request Body

Optional per-run input for the script

context object

Input passed to your script as context for this run only, in whatever shape your script expects. Omit it to reuse the context most recently captured for this application; sending an empty object explicitly runs with no context.

Responses
204

Success

400

Bad Request

Schema — OPTIONAL
status integer — OPTIONAL
message string — OPTIONAL
403

Forbidden

404

Not Found