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

SERVICE_BULK_CUSTOMER_REFRESH_ENTITLEMENTS

{
  "type" : "object",
  "properties" : {
    "customers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "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",
            "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:customer:CustomerConsents",
            "properties" : {
              "contactMethods" : {
                "type" : "array",
                "items" : {
                  "type" : "string"
                }
              },
              "consentPrefs" : {
                "type" : "array",
                "items" : {
                  "type" : "string"
                }
              }
            }
          },
          "customAttributes" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:customer:CustomAttribute",
              "properties" : {
                "name" : {
                  "type" : "string"
                },
                "value" : {
                  "type" : "string"
                }
              }
            }
          },
          "entitlements" : {
            "type" : "object",
            "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:EntitlementList",
            "properties" : {
              "subscriptions" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:SubscriptionEntitlement",
                  "properties" : {
                    "itemCode" : {
                      "type" : "string"
                    },
                    "itemName" : {
                      "type" : "string"
                    },
                    "entitlementIds" : {
                      "type" : "array",
                      "items" : {
                        "type" : "string"
                      }
                    },
                    "entitlements" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:Entitlement:EntitlementDetails",
                        "properties" : {
                          "id" : {
                            "type" : "string"
                          },
                          "name" : {
                            "type" : "string"
                          }
                        }
                      }
                    },
                    "vcn" : {
                      "type" : "integer"
                    }
                  }
                }
              },
              "ppv" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:PPVEntitlement",
                  "properties" : {
                    "itemCode" : {
                      "type" : "string"
                    },
                    "itemName" : {
                      "type" : "string"
                    },
                    "entitlementIds" : {
                      "type" : "array",
                      "items" : {
                        "type" : "string"
                      }
                    },
                    "entitlements" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "$ref" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:Entitlement:EntitlementDetails"
                      }
                    },
                    "itemDataId" : {
                      "type" : "string"
                    },
                    "itemDataName" : {
                      "type" : "string"
                    },
                    "vcn" : {
                      "type" : "integer"
                    }
                  }
                }
              },
              "accessPasses" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:AccessPassEntitlement",
                  "properties" : {
                    "itemCode" : {
                      "type" : "string"
                    },
                    "itemName" : {
                      "type" : "string"
                    },
                    "entitlementIds" : {
                      "type" : "array",
                      "items" : {
                        "type" : "string"
                      }
                    },
                    "entitlements" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "$ref" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:entitlement:Entitlement:EntitlementDetails"
                      }
                    },
                    "itemDataId" : {
                      "type" : "string"
                    },
                    "itemDataName" : {
                      "type" : "string"
                    },
                    "groupName" : {
                      "type" : "string"
                    },
                    "startTime" : {
                      "type" : "string",
                      "format" : "date-time"
                    },
                    "endTime" : {
                      "type" : "string",
                      "format" : "date-time"
                    },
                    "hoursDuration" : {
                      "type" : "integer"
                    }
                  }
                }
              },
              "vcn" : {
                "type" : "array",
                "items" : {
                  "type" : "integer"
                }
              }
            }
          },
          "referAFriend" : {
            "type" : "object",
            "id" : "urn:jsonschema:com:paywizard:services:bbragile:eventstream:model:data:customer:ReferAFriend",
            "properties" : {
              "code" : {
                "type" : "string"
              },
              "active" : {
                "type" : "boolean"
              }
            }
          }
        },
        "required": ["customerId", "username", "email", "title", "firstName", "lastName", "countryCode", "consents"]
      }
    }
  }
}