Create
POST/rules
Create
Request
- application/json
Body
required
Array [
]
Description for the rule
fixes
object[]
The list of fixes to apply when the rule validation fails.
Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]
Possible values: [RECOMMENDED, REQUIRED]
The rule level.
The rule name.
The project id, if applicable.
Possible values: [SMART_CONTENT, CONTENT_GENERATION]
The project type, if applicable.
Possible values: [USER, PROJECT]
The rule scope.
The rule type, one of field, word or code. By default field.
Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]
The left hand side operand for what condition.
The right hand side operand for what condition.
Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]
The operator for what condition.
The left hand side operand for when condition.
The right hand side operand for when condition.
Possible values: [ALWAYS, EQUALS, NOT_EQUALS]
The operator for when condition.
Responses
- 201
- 400
- 401
Created
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The create date-time.
Description for the rule
fixes
object[]
The list of fixes to apply when the rule validation fails.
Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]
Possible values: [RECOMMENDED, REQUIRED]
The rule level.
The last modified date-time.
The rule name.
Possible values: [SMART_CONTENT, CONTENT_GENERATION]
The project type, if applicable.
Possible values: [USER, PROJECT]
The rule scope.
The rule type, one of field, word or code. By default field.
Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]
The left hand side operand for what condition.
The right hand side operand for what condition.
Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]
The operator for what condition.
The left hand side operand for when condition.
The right hand side operand for when condition.
Possible values: [ALWAYS, EQUALS, NOT_EQUALS]
The operator for when condition.
{
"created_at": "2024-07-29T15:51:28.071Z",
"description": "string",
"fixes": [
{
"type": "FIND_AND_REPLACE",
"what": "string",
"with": "string"
}
],
"id": 0,
"is_enabled": true,
"level": "RECOMMENDED",
"modified_at": "2024-07-29T15:51:28.071Z",
"name": "string",
"project_id": 0,
"project_type": "SMART_CONTENT",
"scope": "USER",
"type": "string",
"what_operand_lhs": "EVERYWHERE",
"what_operand_rhs": "string",
"what_operator": "CONTAINS",
"when_operand_lhs": "string",
"when_operand_rhs": "string",
"when_operator": "ALWAYS"
}
Bad request
Authentication Failure