ClientEmailUpdatedV2

v2.0.0

{
  "$id": "https://example.com/ClientEmailUpdatedV2.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientEmailUpdatedV2",
  "description": "An event raised when a client email is updated",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g ClientEmailUpdatedV2"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
        "applicationBreadcrumb": {
          "type": "string",
          "description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
        },
        "version":{
          "type": "string",
          "description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
        },  
        "sentAtUtc": {
          "type": "string",
          "description":  "When event was sent by the publishers in ISO 8601 "
        },
         "isTransactionalAccountAvailableForClient": {
          "type": "boolean",
          "description":  "Indicates if the transaction account for a client is available"
        }                  
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
    },
    "data": {
      "type": "object",
      "properties": {
        "client": {
          "type": "object",
          "properties": {
            "globalClientId": {
              "type": "string",
              "description": "The GUID of client"
            },
            "clientNumber": {
              "type": "number",
              "description": "The CRM number of the client"
            },
            "type": {
              "type": "string",
              "description": "The type of client, e.g. Person or Organisation"
            },
            "primaryGlobalClientEmailId": {
              "type": "string",
              "description": "The GUID of the primary email of the client"
            },
            "digitalProfileClientEmailId": {
              "type": "string",
              "description": "The GUID of the digital profile email of the client"
            }
          }
        },
        "email": {
          "type": "object",
          "properties": {
               "globalClientEmailId": {
                "type": "string",
                "description": "The GUID of the email of the client"
              },
              "address": {
                "type": "string",
                "description": "The email address of the client"
              },
              "status": {
                "type": "string",
                "description": "The status of the email address. Allowed values: Current, Do not use, Incorrect, Old"
              }
          }
        }
      }
    }
  }
}