/
Create a draft ruleset

Create a draft ruleset

Request

Creates a draft ruleset for a specified event type.

Security
SecretApiKey or JWT
Path
eventTypestringrequired

Type of event.

Bodyapplication/jsonrequired

Draft ruleset resource.

baseVersioninteger, >= 0required

Ruleset version on which the draft ruleset is based. Generally, a draft ruleset is cloned from an existing ruleset. Use this field to determine if the active ruleset changed since the draft creation. 0 denotes a draft ruleset that is not created from an existing ruleset. The value of this field is informational only, it is not assigned to the active ruleset.

bindsArray of objects(Bind)

Binds always execute, regardless of rule based events. A rule is a configuration of an event and one or more actions.

rulesArray of objects(Rule)required

Rule can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

namestringrequired

Name of the draft.

descriptionstring

Detailed description of the drafted ruleset.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/events/{eventType}/rules/drafts' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "baseVersion": 0,
    "binds": [
      {
        "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
        "name": "string",
        "labels": [
          "test-rule",
          "category:foo"
        ],
        "status": "active",
        "filter": "string",
        "actions": [
          {
            "name": "abandon-scheduled-payments",
            "status": "active"
          }
        ]
      }
    ],
    "rules": [
      {
        "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
        "name": "string",
        "labels": [
          "test-rule",
          "category:foo"
        ],
        "status": "active",
        "filter": "string",
        "actions": [
          {
            "name": "abandon-scheduled-payments",
            "status": "active"
          }
        ],
        "final": true
      }
    ],
    "name": "string",
    "description": "string"
  }'

Responses

Draft ruleset created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the draft rule set.

Example:"rule_dft_0YVDN3FN43CEQ8CQ93Y0H00ZQ7"
baseVersioninteger, >= 0required

Ruleset version on which the draft ruleset is based. Generally, a draft ruleset is cloned from an existing ruleset. Use this field to determine if the active ruleset changed since the draft creation. 0 denotes a draft ruleset that is not created from an existing ruleset. The value of this field is informational only, it is not assigned to the active ruleset.

bindsArray of objects(Bind)

Binds always execute, regardless of rule based events. A rule is a configuration of an event and one or more actions.

rulesArray of objects(Rule)required

Rule can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

authorobjectread-only

Author of the draft.

namestringrequired

Name of the draft.

descriptionstring

Detailed description of the drafted ruleset.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "rule_dft_0YVDN3FN43CEQ8CQ93Y0H00ZQ7",
  "baseVersion": 0,
  "binds": [
    { … }
  ],
  "rules": [
    { … }
  ],
  "author": {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "name": "string"
  },
  "name": "string",
  "description": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}