Communication

stripstringrequired

Banner URL

wallet objectrequired

oneOf

• Wallet
• string

namestringrequired

logostringrequired

iconstringrequired

androidLogostring

displayIdentifiantbooleanrequired

passBuilderPassTemplateIdstring

passBuilderBusinessIdstring

passBuilderTokenstring

identifierstringrequired

identifierQrstringrequired

addressstring

websitestringrequired

servicePhonestringrequired

businessPhonestringrequired

socialMedia objectrequired

linkedinstring

facebookstring

instagramstring

tiktokstring

twitterstring

youtubestring

snapchatstring

pintereststring

redditstring

whatsappstring

telegramstring

additionalContacts object[]required

Array [

titlestringrequired

valuestringrequired

kindstringrequired

Possible values: [URL, PHONE, EMAIL]

]

termsAndConditions objectrequired

typestringrequired

Possible values: [PDF, URL, NONE]

customUrlstring

pdfUrlstring

webHookUrlstringrequired

rootDomainstringrequired

timezonestring

allowedPassesstring[]required

Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

expiredCleanupEnabledbooleanrequired

_idstringrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

storeCard object

oneOf

• StoreCard
• string

wallet objectrequired

oneOf

• Wallet
• string

namestringrequired

logostringrequired

iconstringrequired

androidLogostring

displayIdentifiantbooleanrequired

passBuilderPassTemplateIdstring

passBuilderBusinessIdstring

passBuilderTokenstring

identifierstringrequired

identifierQrstringrequired

addressstring

websitestringrequired

servicePhonestringrequired

businessPhonestringrequired

socialMedia objectrequired

linkedinstring

facebookstring

instagramstring

tiktokstring

twitterstring

youtubestring

snapchatstring

pintereststring

redditstring

whatsappstring

telegramstring

additionalContacts object[]required

Array [

titlestringrequired

valuestringrequired

kindstringrequired

Possible values: [URL, PHONE, EMAIL]

]

termsAndConditions objectrequired

typestringrequired

Possible values: [PDF, URL, NONE]

customUrlstring

pdfUrlstring

webHookUrlstringrequired

rootDomainstringrequired

timezonestring

allowedPassesstring[]required

Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

expiredCleanupEnabledbooleanrequired

_idstringrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

cardTypestringrequired

Possible values: [STORE_CARD, MEMBER_CARD]

displayIdentifiantbooleanrequired

displayWalletNameboolean

stripstringrequired

passBuilderPassTemplateIdstring

programNamestring

keysHasChangedstring[]

startRowstring

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

middleRowstring

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

endRowstring

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

iosHeader object

labelEnumstringrequired

Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

valueEnumstringrequired

Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

customLabelstring

customValuestring

barcodeTypestringrequired

Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

descriptions object[]required

Array [

titlestringrequired

valuestringrequired

]

openingHoursstringrequired

colors objectrequired

labelColorstringrequired

backgroundColorstringrequired

foregroundColorstringrequired

oneTimeToUsebooleanrequired

sharingProhibitedbooleanrequired

sharingProhibitedAndroidbooleanrequired

validity objectrequired

expirationTypestringrequired

Possible values: [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

expirationDatestring<date-time>

expirationAfterPeriodstring

expirationPeriodTypestring

Possible values: [YEARS, MONTHS, WEEKS]

expirationOptionstring

Possible values: [AT_CREATION_DATE, END_OF_MONTH]

gainLabelstringrequired

Possible values: [GAIN, GAINS, CAGNOTE, POINTS]

gainUnitstringrequired

Possible values: [NONE, EURO, USD, MAD, POINTS]

offerLabelstringrequired

enableDisplayIdentifiantbooleanrequired

gainFormatMigratedbooleanrequired

Marks whether the PassBuilder template and all existing passes have been migrated to the new gain format where the unit symbol is embedded in the pass attribute value (e.g. "50 Pts") rather than in the template field. False (or absent) means the old format is still in use.

_idstringrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

descriptionstringrequired

Communication description

startDatestring<date-time>

Communication start date

endDatestring<date-time>

Communication end date

minPointsnumber

Minimum points required

Possible values: >= 0

maxPointsnumber

Maximum points allowed

Possible values: >= 0

statusstringrequired

Communication status

Possible values: [PENDING, ACTIVE, INACTIF, EXPIRED]

Default value: PENDING

instantbooleanrequired

unlimitedbooleanrequired

_idstringrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

Communication

{
  "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"
}