Update Customer Vetting Rule

Authentication

Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-update-compliance-rules permission is required to access this endpoint.

To retrieve the customer_rule_id before updating, use the List Customer Compliance Rules endpoint, which requires the external-api-compliance-rules permission.

Endpoint

URL: https://api.genlogs.io/customer-compliance-rules/{customer_rule_id} Method: PATCH

Updates the status and/or parameter values of an existing customer compliance rule. At least one of status or param_values must be provided.

Path Parameters

Parameter	Type	Required	Description
customer_rule_id	string (UUID)	Yes	Unique identifier of the customer compliance rule to update.

Request Body

Field	Type	Required	Description
status	string	No*	Rule status. Allowed values: enabled, disabled.
param_values	object	No*	Rule configuration values used during carrier evaluation.

* At least one of status or param_values must be provided.

Observed by GenLogs Validation

When updating the Observed by GenLogs rule, param_values is strictly validated before the update is processed.

Validation applies only to this external API endpoint. Internal GenLogs UI/API update flows are not affected.

date_interval

Must be a supported interval value:

• 1_day

• 7_days

• 14_days

• 1_month

• 3_months

• 6_months

• 12_months

• 18_months

• 2_years

• 3_years

• 4_plus_years

decision_matrix

Must follow this structure:

{"false": "<value>","true": "<value>"}

Rules:

• Only allowed keys: false, true

• false must be review or fail

• true must be pass

• No extra keys are allowed

Valid combinations:

false	true
review	pass
fail	pass

fail_message

Must be a strict boolean (true or false).

Rejected examples:

• "false" (string)

• 0 (number)

pass_message

Must be a strict boolean (true or false).

Rejected examples:

• "true" (string)

• 1 (number)

Request Examples

Update status only

curl --location --request PATCH 'https://api.genlogs.io/customer-compliance-rules/{id}' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "status": "enabled"
}'

Update Observed by GenLogs rule — review when not observed

curl --location --request PATCH 'https://api.genlogs.io/customer-compliance-rules/{id}' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "status": "enabled",
  "param_values": {
    "date_interval": "1_month",
    "decision_matrix": {
      "false": "review",
      "true": "pass"
    },
    "fail_message": false,
    "pass_message": true
  }
}'

Responses

Status	Description
200 OK	Customer compliance rule updated successfully.
400 Bad Request	Invalid request body, missing required fields, or invalid param_values.
401 Unauthorized	Authentication credentials are missing or invalid.
403 Forbidden	User does not have the required permission.
404 Not Found	Customer compliance rule does not exist.
500 Internal Server Error	Server error while processing the request.

Response Body

200 OK

{
  "message": "Success! The customer rule has been updated.",
  "status_code": 200
}

400 Bad Request

Returned when:

• Neither status nor param_values is provided

• param_values contains invalid Observed by GenLogs values

Missing update fields

{
    "message": "At least status or param_values must be provided for update"
}

Invalid date_interval

{
    "detail": "Invalid param_values for Observed by GenLogs: param_values.date_interval: Value error, Unsupported date interval: last_week"
}

Invalid decision_matrix value

{
    "detail": "Invalid param_values for Observed by GenLogs: param_values.decision_matrix.false: Input should be 'review' or 'fail'"
}

Invalid decision_matrix combination

{
    "detail": "Invalid param_values for Observed by GenLogs: param_values.decision_matrix.true: Input should be 'pass'"
}

Non-boolean message flags

{
    "detail": "Invalid param_values for Observed by GenLogs: param_values.fail_message: Input should be a valid boolean"
}

401 Unauthorized

{
    "detail": {"message": "Token is missing","subcode": "TOKEN_MISSING"}
}

403 Forbidden

{
    "detail": "User does not have the required permissions to access this resource"
}

404 Not Found

{
    "message": "Customer rule id: {id} not found"
}

Update customer compliance rule

patch

Updates the status and/or parameter values of an existing customer compliance rule. At least one of status or param_values must be provided. The authenticated company must have vetting access permissions.

Authorizations

Access-TokenstringRequired

JWT provided directly in the Access-Token header.

x-api-keystringRequired

API key provided by GenLogs.

Path parameters

customer_rule_idstring · uuidRequired

Unique identifier of the customer compliance rule.

Example: 8bafc1c4-3d2a-4c90-9e12-1c7c9c0f1a22

Body

anyOptional

or

anyOptional

Responses

200

Customer compliance rule updated successfully.

application/json

status_codestringOptionalExample: 200

messagestringOptionalExample: Success! The customer rule has been updated.

400

Bad Request – Invalid input, missing required fields, or invalid external rule param_values.

application/json

401

Unauthorized – Invalid or missing Access-Token.

application/json

403

Forbidden – Company user does not have vetting access permission.

application/json

404

Not Found – Customer compliance rule does not exist.

application/json

500

Internal Server Error.

application/json

patch/customer-compliance-rules/{customer_rule_id}

PATCH /customer-compliance-rules/{customer_rule_id} HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "status": "enabled",
  "param_values": {
    "date_interval": "7_days",
    "decision_matrix": {
      "false": "fail",
      "true": "pass"
    },
    "fail_message": false,
    "pass_message": true
  }
}

{
  "status_code": "200",
  "message": "Success! The customer rule has been updated."
}