HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides
These docs are for v2024.01. Click to read the latest docs for v2024.08.01.

SERVICE_CUSTOMER_UPDATE

{
  "type" : "object",
  "description": "Data used for SERVICE_CUSTOMER_REGISTER and SERVICE_CUSTOMER_UPDATE",
  "properties" : {
    "customerId" : {
      "type" : "string"
    },
    "externalUniqueIdentifier" : {
      "type" : "string"
    },
    "username" : {
      "type" : "string"
    },
    "email" : {
      "type" : "string"
    },
    "title" : {
      "type" : "string"
    },
    "firstName" : {
      "type" : "string"
    },
    "lastName" : {
      "type" : "string"
    },
    "dateOfBirth" : {
      "type" : "string",
      "format" : "date-time"
    },
    "countryCode" : {
      "type" : "string"
    },
    "postCode" : {
      "type" : "string"
    },
    "consents" : {
      "type" : "object",
      "properties" : {
        "contactMethods" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "consentPrefs" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        }
      }
    },
    "customAttributes" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    },
    "referAFriend" : {
      "type" : "object",
      "properties" : {
        "code" : {
          "type" : "string"
        },
        "active" : {
          "type" : "boolean"
        }
      }
    },
    "phone" : {
      "type" : "string"
    },
    "addresses" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "line1" : {
            "type" : "string"
          },
          "line2" : {
            "type" : "string"
          },
          "line3" : {
            "type" : "string"
          },
          "city" : {
            "type" : "string"
          },
          "countryCode" : {
            "type" : "string"
          },
          "postCode" : {
            "type" : "string"
          },
          "addressType" : {
            "type" : "string"
          },
          "auditInfo" : {
            "type" : "object",
            "properties" : {
              "createdByUser" : {
                "type" : "string"
              },
              "creationDate" : {
                "type" : "string",
                "format" : "date-time"
              },
              "modifiedByUser" : {
                "type" : "string"
              },
              "modifiedDate" : {
                "type" : "string",
                "format" : "date-time"
              }
            }
          }
        }
      }
    },
    "active" : {
      "type" : "boolean"
    },
    "auditInfo" : {
      "type" : "object",
      "properties" : {
        "createdByUser" : {
          "type" : "string"
        },
        "creationDate" : {
          "type" : "string",
          "format" : "date-time"
        },
        "modifiedByUser" : {
          "type" : "string"
        },
        "modifiedDate" : {
          "type" : "string",
          "format" : "date-time"
        }
      }
    }
  },
  "required": ["customerId", "username", "email", "title", "firstName", "lastName", "countryCode", "consents", "addresses", "active", "auditInfo"]
}