Skip to main content
POST
/
rulesets
/
create
Create a new ruleset
curl --request POST \
  --url https://rules.platform.arb.inc/rulesets/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "defaultRules",
  "title": "Default Arbitration Rules",
  "description": "Standard rules for small claims disputes.",
  "markdown": "# Small Claims Arbitration Rules\n\nThese rules apply to small claims disputes involving parking lots.\n1. Parties must submit documents by the listed deadlines.\n2. Evidence can be uploaded during the evidence phase.\n",
  "timetable": {
    "phases": [
      {
        "id": "caseInitation",
        "durationInSeconds": 604800,
        "allowEvidenceSubmission": false,
        "documents": [
          {
            "id": "statementOfClaim",
            "filedBy": "claimant",
            "approvedBy": null,
            "maxAllowed": 1,
            "required": true,
            "recommended": false
          }
        ]
      },
      {
        "id": "response",
        "durationInSeconds": 604800,
        "allowEvidenceSubmission": true,
        "documents": [
          {
            "id": "motion",
            "filedBy": "respondent",
            "approvedBy": null,
            "maxAllowed": 1,
            "required": true,
            "recommended": false
          },
          {
            "id": "statementOfResponse",
            "filedBy": "respondent",
            "approvedBy": null,
            "maxAllowed": 15,
            "required": false,
            "recommended": true
          }
        ]
      }
    ]
  },
  "isActive": true
}
'
"ruleset successfully created, don't forget to activate it"

Authorizations

Authorization
string
header
required

access token

Body

application/json
id
string
required

Unique ID for the ruleset.

Example:

"defaultRules"

title
string
required

Short title for this ruleset.

Example:

"Default Arbitration Rules"

description
string
required

Simple description of what this ruleset is for.

Example:

"Standard rules for small claims disputes."

markdown
string
required

Full rules content in markdown format.

Example:

"# Small Claims Arbitration Rules\n\nThese rules apply to small claims disputes involving parking lots.\n1. Parties must submit documents by the listed deadlines.\n2. Evidence can be uploaded during the evidence phase.\n"

timetable
object
required

Timetable that defines the phases of the case.

isActive
boolean

Whether this ruleset is currently active and can be used.

Example:

true

Response

200 - text/plain

ruleset successfully created.

The response is of type string.

Example:

"ruleset successfully created, don't forget to activate it"