Create a rule

post

https://api.cardda.com/v1/erp/payouts/rules

Creates an automation rule with its constraints and effects. applicable_model is set
once here and is immutable afterwards.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body used to create or update a rule. On update, applicable_model is ignored (immutable after creation). Effects are passed as nested attribute arrays.

name

string

company_id

uuid

enabled

boolean

inheritable

boolean

applicable_model

string

Target bucket. Defaults to tradables. Only honored on create.

constraints

object

Constraint tree as a flat map of dotted paths to values, expanded server-side into nested constraint attributes.

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

422

Unprocessable Entity

Language

Credentials

Bearer

Loading…

Response

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

application/json

201The created rule.