Override an inherited rule

patch

https://api.cardda.com/v1/erp/payouts/rules/{id}/override

Creates or updates the current company's override of an inherited (corporate-group) rule
identified by {id}. Returns the inherited rule with its updated override block.

Pass inherit_override to control whether the override itself propagates to child
companies. Include the standard rule fields (name, enabled, effects, constraints)
to define the overriding behavior.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The ID of the resource

Body Params

name

string

enabled

boolean

inherit_override

boolean

Whether the override propagates to child companies.

constraints

object

attribute_change_effects

array of objects

attribute_change_effects

custom_column_change_effects

array of objects

custom_column_change_effects

reviewer_assigner_effects

array of objects

reviewer_assigner_effects

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent, both values must match;
the API returns 422 Unprocessable Entity when they disagree.

Responses

401

Unauthorized

404

Inherited rule not found

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The inherited rule with the updated override.