Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Path Parameters

rule_id
string
required

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to update the rule for. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:

Body

application/json
optionalProperty
any

Response

Successfully Updated

id
string<uuid>

Finch id (uuidv4) for the rule.

Pattern: [0-9a-f]{8}[-]?(?:[0-9a-f]{4}[-]?){3}[0-9a-f]{12}
priority
integer

The priority of the rule.

created_at
string<date-time>

The datetime when the rule was created.

updated_at
string<date-time>

The datetime when the rule was last updated.

effective_start_date
string | null

Specifies when the rule should begin applying based on the date.

Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
effective_end_date
string | null

Specifies when the rules should stop applying rules based on the date.

Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
conditions
object[]
attributes
object

Specifies the fields to be applied when the condition is met.

entity_type
enum<string>

The entity type to which the rule is applied.

Available options:
pay_statement_item