Skip to main content

Update

PUT 

/rules/:id

Update

Request

Path Parameters

    id int64required

    The id

Body

required

    description string

    Description for the rule

    fixes

    object[]

    The list of fixes to apply when the rule validation fails.

  • Array [

  • type ValidationTypeEnum (string)

    Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]

    what string
    with string
  • ]

  • is_enabled boolean
    level LevelEnum (string)required

    Possible values: [RECOMMENDED, REQUIRED]

    The rule level.

    name stringrequired

    The rule name.

    project_id int64

    The project id, if applicable.

    project_type ProjectType (string)

    Possible values: [SMART_CONTENT, CONTENT_GENERATION]

    The project type, if applicable.

    scope Scope (string)required

    Possible values: [USER, PROJECT]

    The rule scope.

    type stringrequired

    The rule type, one of field, word or code. By default field.

    what_operand_lhs WhatOperandLhs (string)required

    Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]

    The left hand side operand for what condition.

    what_operand_rhs stringrequired

    The right hand side operand for what condition.

    what_operator WhatOperator (string)required

    Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]

    The operator for what condition.

    when_operand_lhs stringrequired

    The left hand side operand for when condition.

    when_operand_rhs stringrequired

    The right hand side operand for when condition.

    when_operator WhenOperator (string)required

    Possible values: [ALWAYS, EQUALS, NOT_EQUALS]

    The operator for when condition.

Responses

Found.

Schema

    created_at date-time

    The create date-time.

    description string

    Description for the rule

    fixes

    object[]

    The list of fixes to apply when the rule validation fails.

  • Array [

  • type ValidationTypeEnum (string)

    Possible values: [FIND_AND_REPLACE, OPEN_AI, APPEND]

    what string
    with string
  • ]

  • id int64
    is_enabled boolean
    level LevelEnum (string)required

    Possible values: [RECOMMENDED, REQUIRED]

    The rule level.

    modified_at date-time

    The last modified date-time.

    name stringrequired

    The rule name.

    project_id int64
    project_type ProjectType (string)

    Possible values: [SMART_CONTENT, CONTENT_GENERATION]

    The project type, if applicable.

    scope Scope (string)required

    Possible values: [USER, PROJECT]

    The rule scope.

    type stringrequired

    The rule type, one of field, word or code. By default field.

    what_operand_lhs WhatOperandLhs (string)required

    Possible values: [EVERYWHERE, FIRST_SENTENCE, LAST_SENTENCE]

    The left hand side operand for what condition.

    what_operand_rhs stringrequired

    The right hand side operand for what condition.

    what_operator WhatOperator (string)required

    Possible values: [CONTAINS, DOESNT_CONTAIN, ENDS_WITH, REGEX, REGEX_DOESNT_MATCH]

    The operator for what condition.

    when_operand_lhs stringrequired

    The left hand side operand for when condition.

    when_operand_rhs stringrequired

    The right hand side operand for when condition.

    when_operator WhenOperator (string)required

    Possible values: [ALWAYS, EQUALS, NOT_EQUALS]

    The operator for when condition.