POST
/v1/workspace/underwriting/rule-setsCreate an underwriting rule set
Create a DRAFT rule set: a name, and optionally the deal stage and product it narrows to (both empty mean every deal). It judges nothing until it is published. Add rules with the rules route, then publish.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Request body
application/jsonrequiredbodyoptional
paramsobjectoptional
queryobjectoptional
Responses
201application/json
the action's answer
{
"data": {
"appliesToProduct": "string",
"appliesToStage": "string",
"createdAt": "string",
"createdByAccountId": "",
"description": "string",
"hasUnpublishedChanges": true,
"id": 1,
"key": "string",
"name": "string",
"publishedAt": "string",
"publishedByAccountId": "",
"publishedVersion": 1,
"rules": [
{
"active": "string",
"condition": "string",
"createdAt": "string",
"id": "",
"key": "string",
"name": "string",
"outcome": "string",
"reasonTemplate": "string",
"setId": "",
"sortOrder": "string",
"sourceText": "string",
"updatedAt": "string",
"weight": "string"
}
],
"seeded": true,
"status": "string",
"updatedAt": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired