Communication
URL de l'image du bandeau.
wallet objectobligatoire
- Wallet
- string
socialMedia objectobligatoire
additionalContacts object[]obligatoire
Valeurs possibles : [URL, PHONE, EMAIL]
termsAndConditions objectobligatoire
Valeurs possibles : [PDF, URL, NONE]
Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]
storeCard object
- StoreCard
- string
wallet objectobligatoire
- Wallet
- string
socialMedia objectobligatoire
additionalContacts object[]obligatoire
Valeurs possibles : [URL, PHONE, EMAIL]
termsAndConditions objectobligatoire
Valeurs possibles : [PDF, URL, NONE]
Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]
Valeurs possibles : [STORE_CARD, MEMBER_CARD]
Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]
Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]
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
Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]
Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]
Valeurs possibles : [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]
descriptions object[]obligatoire
colors objectobligatoire
validity objectobligatoire
Valeurs possibles : [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]
Valeurs possibles : [YEARS, MONTHS, WEEKS]
Valeurs possibles : [AT_CREATION_DATE, END_OF_MONTH]
Valeurs possibles : [GAIN, GAINS, CAGNOTE, POINTS]
Valeurs possibles : [NONE, EURO, USD, MAD, POINTS]
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é.
Description de la communication.
Date de début de la communication.
Date de fin de la communication.
Nombre minimal de points requis.
Valeurs possibles : >= 0
Nombre maximal de points autorisés.
Valeurs possibles : >= 0
Statut de la communication.
Valeurs possibles : [PENDING, ACTIVE, INACTIF, EXPIRED]
PENDING{
"strip": "string",
"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"
},
"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"
},
"description": "string",
"startDate": "2024-07-29T15:51:28.071Z",
"endDate": "2024-07-29T15:51:28.071Z",
"minPoints": 0,
"maxPoints": 0,
"status": "PENDING",
"instant": true,
"unlimited": true,
"_id": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z"
}