API Docs / Schemas / ClientEmailRuleDto

ClientEmailRuleDto

A rule that associates emails with a client.
The value determines the matching behaviour:
email addresses (contain '@') match that specific participant,
domains (no '@', not a GUID) match all emails from that domain,
message IDs (valid GUID) pin a specific email to this client.
The same value can be a rule for multiple clients.

Properties

Name Type Description
codestring

The unique code for this rule

The unique code for this rule

clientCodeAndNameDto
valuestring

The email address, domain, or message ID to match.
Email addresses (contain '@') match that specific participant.
Domains (no '@', not a GUID) match all emails from that domain.
Message IDs (valid GUID) pin a specific email to this client.

The email address, domain, or message ID to match.
Email addresses (contain '@') match that specific participant.
Domains (no '@', not a GUID) match all emails from that domain.
Message IDs (valid GUID) pin a specific email to this client.

createdDatestring

When the rule was created

When the rule was created

updatedDatestring

When the rule was last updated

When the rule was last updated

isAutoAddedboolean

Whether this rule was automatically added from client/contact email addresses.
Auto-added rules are maintained by the system and updated when the source email changes.

Whether this rule was automatically added from client/contact email addresses.
Auto-added rules are maintained by the system and updated when the source email changes.

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "value": "string",
  "createdDate": "2024-01-01T00:00:00Z",
  "updatedDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas