Update Customer Vetting Rule | Genlogs API Docs

On this page

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

Request Body

* 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.

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: review
• true: pass
• false: fail
• true: 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

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 https://api.genlogs.io/customer-compliance-rules/{customer_rule_id}

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-Token
• X-Api-Key

Path parameters

| customer_rule_id | string · uuid | Required | Unique identifier of the customer compliance rule. | | Example: | 8bafc1c4-3d2a-4c90-9e12-1c7c9c0f1a22 | |

Body

| Content-Type | application/json | | |-------------------|------------------| |

Responses

Test it

Customer compliance rule updated successfully.

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