PushNotification

wallet objectobligatoire

oneOf

• Wallet
• string

namestringobligatoire

logostringobligatoire

iconstringobligatoire

androidLogostring

displayIdentifiantbooleanobligatoire

passBuilderPassTemplateIdstring

passBuilderBusinessIdstring

passBuilderTokenstring

identifierstringobligatoire

identifierQrstringobligatoire

addressstring

websitestringobligatoire

servicePhonestringobligatoire

businessPhonestringobligatoire

socialMedia objectobligatoire

linkedinstring

facebookstring

instagramstring

tiktokstring

twitterstring

youtubestring

snapchatstring

pintereststring

redditstring

whatsappstring

telegramstring

additionalContacts object[]obligatoire

Array [

titlestringobligatoire

valuestringobligatoire

kindstringobligatoire

Valeurs possibles : [URL, PHONE, EMAIL]

]

termsAndConditions objectobligatoire

typestringobligatoire

Valeurs possibles : [PDF, URL, NONE]

customUrlstring

pdfUrlstring

webHookUrlstringobligatoire

rootDomainstringobligatoire

timezonestring

allowedPassesstring[]obligatoire

Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

expiredCleanupEnabledbooleanobligatoire

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

defaultTitlestringobligatoire

defaultMessagestringobligatoire

targetstringobligatoire

Valeurs possibles : [ALL, SPECIFIC]

typestringobligatoire

Valeurs possibles : [INSTANT, SCHEDULED]

clients object[]obligatoire

Array [

id objectobligatoire

oneOf

• Client
• string

walletstring

clientType object

oneOf

• ClientType
• string

storeCard objectobligatoire

oneOf

• StoreCard
• string

wallet objectobligatoire

oneOf

• Wallet
• string

namestringobligatoire

logostringobligatoire

iconstringobligatoire

androidLogostring

displayIdentifiantbooleanobligatoire

passBuilderPassTemplateIdstring

passBuilderBusinessIdstring

passBuilderTokenstring

identifierstringobligatoire

identifierQrstringobligatoire

addressstring

websitestringobligatoire

servicePhonestringobligatoire

businessPhonestringobligatoire

socialMedia objectobligatoire

linkedinstring

facebookstring

instagramstring

tiktokstring

twitterstring

youtubestring

snapchatstring

pintereststring

redditstring

whatsappstring

telegramstring

additionalContacts object[]obligatoire

Array [

titlestringobligatoire

valuestringobligatoire

kindstringobligatoire

Valeurs possibles : [URL, PHONE, EMAIL]

]

termsAndConditions objectobligatoire

typestringobligatoire

Valeurs possibles : [PDF, URL, NONE]

customUrlstring

pdfUrlstring

webHookUrlstringobligatoire

rootDomainstringobligatoire

timezonestring

allowedPassesstring[]obligatoire

Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

expiredCleanupEnabledbooleanobligatoire

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

cardTypestringobligatoire

Valeurs possibles : [STORE_CARD, MEMBER_CARD]

displayIdentifiantbooleanobligatoire

displayWalletNameboolean

stripstringobligatoire

passBuilderPassTemplateIdstring

programNamestring

keysHasChangedstring[]

startRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

middleRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

endRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

iosHeader object

labelEnumstringobligatoire

Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

valueEnumstringobligatoire

Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

customLabelstring

customValuestring

barcodeTypestringobligatoire

Valeurs possibles : [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

descriptions object[]obligatoire

Array [

titlestringobligatoire

valuestringobligatoire

]

openingHoursstringobligatoire

colors objectobligatoire

labelColorstringobligatoire

backgroundColorstringobligatoire

foregroundColorstringobligatoire

oneTimeToUsebooleanobligatoire

sharingProhibitedbooleanobligatoire

sharingProhibitedAndroidbooleanobligatoire

validity objectobligatoire

expirationTypestringobligatoire

Valeurs possibles : [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

expirationDatestring<date-time>

expirationAfterPeriodstring

expirationPeriodTypestring

Valeurs possibles : [YEARS, MONTHS, WEEKS]

expirationOptionstring

Valeurs possibles : [AT_CREATION_DATE, END_OF_MONTH]

gainLabelstringobligatoire

Valeurs possibles : [GAIN, GAINS, CAGNOTE, POINTS]

gainUnitstringobligatoire

Valeurs possibles : [NONE, EURO, USD, MAD, POINTS]

offerLabelstringobligatoire

enableDisplayIdentifiantbooleanobligatoire

gainFormatMigratedbooleanobligatoire

Indique si le modèle PassBuilder et tous les passes existants ont été migrés vers le nouveau format de gain, où le symbole de l'unité est intégré à la valeur de l'attribut du pass (par exemple « 50 Pts ») plutôt qu'au champ du modèle. false (ou absent) signifie que l'ancien format est toujours utilisé.

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

namestringobligatoire

isDefaultbooleanobligatoire

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

sourcestringobligatoire

Valeurs possibles : [CRM, INTERNAL, EXTERNAL]

barcodestring

firstNamestringobligatoire

lastNamestringobligatoire

emailstring

companyNamestring

renewalDatestring<date-time>

phoneNumberstring

birthDatestring<date-time>

admissionDatestring<date-time>

gainnumber

gainHistory object[]

Array [

gainnumberobligatoire

datestring<date-time>obligatoire

]

communicationPreferences object[]

Préférences de communication de ce client, par événement et par canal, qui priment sur les règles du wallet (gestion des consentements RGPD). Même structure que WalletSetting.communicationRules. L'absence d'entrée pour un notificationType donné signifie que la communication est activée, comme pour isCommunicationRuleEnabled. L'historique des modifications n'est volontairement pas inclus ici (voir CommunicationPreferenceLog), afin de garder ce document, très souvent lu, léger.

Array [

notificationTypestringobligatoire

Valeurs possibles : [NEW_LOYALTY, UPDATE_LOYALTY, REMINDER_LOYALTY, EARNINGS_UPDATE, NEW_COMMUNICATION, EXPIRED_COMMUNICATION, NEW_EVENT, UPDATE_EVENT, NEW_COUPON, UPDATE_COUPON, WELCOME_INTERNAL_CLIENTS, WELCOME_CRM_CLIENTS, WELCOME_EXTERNAL_CLIENTS, WELCOME_COUPON, EXPIRED_COUPON, TRANSIT_TICKET, UPDATE_TRANSIT, HOTEL_RESERVATION, UPDATE_HOTEL_RESERVATION, CINEMA_TICKET]

smsbooleanobligatoire

emailbooleanobligatoire

notificationbooleanobligatoire

]

pushInformativeEnabledboolean

Désinscription des campagnes de notifications push « standard » créées par un gestionnaire et classées comme informatives.

pushCommercialEnabledboolean

Désinscription des campagnes de notifications push « standard » créées par un gestionnaire et classées comme commerciales.

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

passBuilderPassIdstring

titlestring

messagestring

]

categorystring

Informative/commercial classification, used to gate against the recipient's Client.pushInformativeEnabled/pushCommercialEnabled.

Valeurs possibles : [INFORMATIVE, COMMERCIAL]

scheduleAtstring<date-time>

sentAtstring<date-time>

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

PushNotification

{
  "wallet": {
    "name": "string",
    "logo": "string",
    "icon": "string",
    "androidLogo": "string",
    "displayIdentifiant": true,
    "passBuilderPassTemplateId": "string",
    "passBuilderBusinessId": "string",
    "passBuilderToken": "string",
    "identifier": "string",
    "identifierQr": "string",
    "address": "string",
    "website": "string",
    "servicePhone": "string",
    "businessPhone": "string",
    "socialMedia": {
      "linkedin": "string",
      "facebook": "string",
      "instagram": "string",
      "tiktok": "string",
      "twitter": "string",
      "youtube": "string",
      "snapchat": "string",
      "pinterest": "string",
      "reddit": "string",
      "whatsapp": "string",
      "telegram": "string"
    },
    "additionalContacts": [
      {
        "title": "string",
        "value": "string",
        "kind": "URL"
      }
    ],
    "termsAndConditions": {
      "type": "PDF",
      "customUrl": "string",
      "pdfUrl": "string"
    },
    "webHookUrl": "string",
    "rootDomain": "string",
    "timezone": "string",
    "allowedPasses": [
      "ALL"
    ],
    "expiredCleanupEnabled": true,
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "defaultTitle": "string",
  "defaultMessage": "string",
  "target": "ALL",
  "type": "INSTANT",
  "clients": [
    {
      "id": {
        "wallet": "string",
        "clientType": {
          "storeCard": {
            "wallet": {
              "name": "string",
              "logo": "string",
              "icon": "string",
              "androidLogo": "string",
              "displayIdentifiant": true,
              "passBuilderPassTemplateId": "string",
              "passBuilderBusinessId": "string",
              "passBuilderToken": "string",
              "identifier": "string",
              "identifierQr": "string",
              "address": "string",
              "website": "string",
              "servicePhone": "string",
              "businessPhone": "string",
              "socialMedia": {
                "linkedin": "string",
                "facebook": "string",
                "instagram": "string",
                "tiktok": "string",
                "twitter": "string",
                "youtube": "string",
                "snapchat": "string",
                "pinterest": "string",
                "reddit": "string",
                "whatsapp": "string",
                "telegram": "string"
              },
              "additionalContacts": [
                {
                  "title": "string",
                  "value": "string",
                  "kind": "URL"
                }
              ],
              "termsAndConditions": {
                "type": "PDF",
                "customUrl": "string",
                "pdfUrl": "string"
              },
              "webHookUrl": "string",
              "rootDomain": "string",
              "timezone": "string",
              "allowedPasses": [
                "ALL"
              ],
              "expiredCleanupEnabled": true,
              "_id": "string",
              "createdAt": "2024-07-29T15:51:28.071Z",
              "updatedAt": "2024-07-29T15:51:28.071Z"
            },
            "cardType": "STORE_CARD",
            "displayIdentifiant": true,
            "displayWalletName": true,
            "strip": "string",
            "passBuilderPassTemplateId": "string",
            "programName": "string",
            "keysHasChanged": [
              "string"
            ],
            "startRow": "CREATION_DATE",
            "middleRow": "CREATION_DATE",
            "endRow": "CREATION_DATE",
            "iosHeader": {
              "labelEnum": "TYPE",
              "valueEnum": "TYPE",
              "customLabel": "string",
              "customValue": "string"
            },
            "barcodeType": "AZTEC",
            "descriptions": [
              {
                "title": "string",
                "value": "string"
              }
            ],
            "openingHours": "string",
            "colors": {
              "labelColor": "string",
              "backgroundColor": "string",
              "foregroundColor": "string"
            },
            "oneTimeToUse": true,
            "sharingProhibited": true,
            "sharingProhibitedAndroid": true,
            "validity": {
              "expirationType": "NO_EXPIRATION",
              "expirationDate": "2024-07-29T15:51:28.071Z",
              "expirationAfterPeriod": "string",
              "expirationPeriodType": "YEARS",
              "expirationOption": "AT_CREATION_DATE"
            },
            "gainLabel": "GAIN",
            "gainUnit": "NONE",
            "offerLabel": "string",
            "enableDisplayIdentifiant": true,
            "gainFormatMigrated": true,
            "_id": "string",
            "createdAt": "2024-07-29T15:51:28.071Z",
            "updatedAt": "2024-07-29T15:51:28.071Z"
          },
          "name": "string",
          "isDefault": true,
          "_id": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "source": "CRM",
        "barcode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "companyName": "string",
        "renewalDate": "2024-07-29T15:51:28.071Z",
        "phoneNumber": "string",
        "birthDate": "2024-07-29T15:51:28.071Z",
        "admissionDate": "2024-07-29T15:51:28.071Z",
        "gain": 0,
        "gainHistory": [
          {
            "gain": 0,
            "date": "2024-07-29T15:51:28.071Z"
          }
        ],
        "communicationPreferences": [
          {
            "notificationType": "NEW_LOYALTY",
            "sms": true,
            "email": true,
            "notification": true
          }
        ],
        "pushInformativeEnabled": true,
        "pushCommercialEnabled": true,
        "_id": "string",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "updatedAt": "2024-07-29T15:51:28.071Z"
      },
      "passBuilderPassId": "string",
      "title": "string",
      "message": "string"
    }
  ],
  "category": "INFORMATIVE",
  "scheduleAt": "2024-07-29T15:51:28.071Z",
  "sentAt": "2024-07-29T15:51:28.071Z",
  "_id": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}