Update EventRules

Request

Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the ruleCode number of the eventRule you want to update, with an isActive parameter. Some event rules may also contain specific parameters, which can be set with param0, param1 and param2. For example, global rule 101 may require specific PARAM values as described in the Special Event Rules documentation. Get the above information by calling the List All eventRules endpoint.

Important Note
It is recommended that any changes made to the Event Rules are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

countryCodestring, = 2 charactersrequired

Country code to show events for

Bodyapplication/jsonrequired

To ensure optimal processing efficiency when updating live event rules—whether for removal, addition, or status change—it is best practice to update the entire list of rules in a single operation. Some rules, such as global rule 101, require specific PARAM values. Please refer to the Special Event Rules documentation for guidance on correct parameter usage.

Array [

ruleCodeintegerrequired

The unique ID of the EventRule.

isActiveintegerrequired

Flag to show if EventRule is active or not. 0 for false, 1 for true.

param0string or integer

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

param1string or integer

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

param2string or integer

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

]

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "ruleCode": 101,
      "isActive": 1,
      "param0": 1,
      "param1": "A",
      "param2": true
    },
    {
      "ruleCode": 1802,
      "isActive": 1,
      "param0": "10"
    },
    {
      "ruleCode": 1815,
      "isActive": 0
    }
  ]'

Responses

No Content

Bodyapplication/json

messagestring

Response

{
  "message": "string"
}