Skip to main content
POST
/
v3
/
profiles
/
validation-rules
Create Profile Validation Rule
curl --request POST \
  --url http://localhost/api/v3/profiles/validation-rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "email",
  "rule_type": "exact",
  "applies_to": "create",
  "pattern": "<string>",
  "error_message": "<string>",
  "priority": 123,
  "is_active": true,
  "effective_from": "2023-11-07T05:31:56Z",
  "effective_to": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_by": "<string>",
  "values": [
    {
      "value": "<string>",
      "is_active": true
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "rule_type": "<string>",
    "applies_to": "<string>",
    "pattern": "<string>",
    "error_message": "<string>",
    "priority": 123,
    "is_active": true,
    "effective_from": "<string>",
    "effective_to": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "values": [
      {
        "id": 123,
        "rule_id": 123,
        "value": "<string>",
        "is_active": true,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
name
string
required
Maximum string length: 255
type
enum<string>
required
Available options:
email,
mobile,
name
rule_type
enum<string>
required
Available options:
exact,
domain,
prefix,
regex
applies_to
enum<string>
required
Available options:
create,
update,
import,
all
pattern
string | null
error_message
string | null
Maximum string length: 255
priority
integer | null
is_active
boolean | null
effective_from
string<date-time> | null
effective_to
string<date-time> | null
created_by
string | null
Maximum string length: 255
updated_by
string | null
Maximum string length: 255
values
object[] | null

Response

ProfileValidationRule

data
ProfileValidationRule · object
required