PUT
/
put
/
{ruleId}
curl --request PUT \
  --url https://gateway.finhub.cloud/rules/put/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenantId: <tenantid>' \
  --data '{
  "module": "<string>",
  "category": "<string>",
  "currency": "<string>",
  "structure": {
    "id": "<string>",
    "name": "<string>",
    "value": "<string>",
    "description": "<string>"
  },
  "subCategory": "<string>",
  "subjectIdentifier": "<string>",
  "subjectGroup": "<string>",
  "effectiveStartDate": "2023-11-07T05:31:56Z",
  "effectiveEndDate": "2023-11-07T05:31:56Z",
  "ruleCycle": "<string>",
  "ruleDetail": {
    "maximum": 123,
    "minimum": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "value": 123
  }
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tenantId": "<string>",
  "module": "<string>",
  "category": "<string>",
  "subCategory": "<string>",
  "currency": "<string>",
  "subjectIdentifier": "<string>",
  "subjectGroup": "<string>",
  "effectiveStartDate": "<string>",
  "effectiveEndDate": "<string>",
  "ruleCycle": "<string>",
  "active": true,
  "isDeleted": true,
  "structure": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tenantId": "<any>",
    "name": "<string>",
    "value": "<string>",
    "description": "<any>"
  },
  "ruleDetail": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tenantId": "<any>",
    "maximum": 123,
    "minimum": 123,
    "startDate": "<string>",
    "endDate": "<string>",
    "value": 123
  }
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

tenantId
string
required

Path Parameters

ruleId
string
required

Body

module
string | null
category
string | null
currency
string | null
structure
object
subCategory
string | null
subjectIdentifier
string | null
subjectGroup
string | null
effectiveStartDate
string
effectiveEndDate
string
ruleCycle
string | null
ruleDetail
object

Response

200 - text/plain
id
string | null
createdAt
string
updatedAt
string
tenantId
string | null
module
string | null
category
string | null
subCategory
string | null
currency
string | null
subjectIdentifier
string | null
subjectGroup
string | null
effectiveStartDate
string | null
effectiveEndDate
string | null
ruleCycle
string | null
active
boolean
isDeleted
boolean
structure
object
ruleDetail
object