Skip to main content

Event

statusEventStatusrequired

Possible values: [PENDING, ACTIF, ENDED]

Default value: PENDING
wallet objectrequired
oneOf
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
    barcodeTypestringrequired

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

    namestringrequired
    locations object[]required
  • Array [
  • longitudenumber
    latitudenumber
    addressstring
    locationNamestring
  • ]
  • date object
    startDatestring<date-time>
    endDatestring<date-time>
    doorOpeningHourstring<date-time>
    pricenumber
    gainUnitstring

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

    descriptionstring
    termsstring
    subscriptionMessagestringrequired
    emailSubscriptionMessagestringrequired
    contactPhonestring
    emailstring
    websitestring
    colors objectrequired
    labelColorstringrequired
    backgroundColorstringrequired
    foregroundColorstringrequired
    security object
    enableOneTimeUseboolean
    disableIOSPassSharingboolean
    disablePassLinkSharingboolean
    disableMultipleHoldersboolean
    enableSecurityAnimationboolean
    enableRotatingBarcodeboolean
    passBuilderPassTemplateIdstring
    stripstring
    PKTextAlignmentLeftstring

    Possible values: [CHAIR, ACCESS, PRICE, ZONE, INACTIVE]

    PKTextAlignmentCenterstring

    Possible values: [ROW, INACTIVE]

    PKTextAlignmentRightstring

    Possible values: [INACTIVE, TYPE, SEAT, PLACE, ARMCHAIR, LOCATION, PORT]

    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    Event
    {
    "status": "PENDING",
    "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"
    },
    "barcodeType": "AZTEC",
    "name": "string",
    "locations": [
    {
    "longitude": 0,
    "latitude": 0,
    "address": "string",
    "locationName": "string"
    }
    ],
    "date": {
    "startDate": "2024-07-29T15:51:28.071Z",
    "endDate": "2024-07-29T15:51:28.071Z",
    "doorOpeningHour": "2024-07-29T15:51:28.071Z"
    },
    "price": 0,
    "gainUnit": "NONE",
    "description": "string",
    "terms": "string",
    "subscriptionMessage": "string",
    "emailSubscriptionMessage": "string",
    "contactPhone": "string",
    "email": "string",
    "website": "string",
    "colors": {
    "labelColor": "string",
    "backgroundColor": "string",
    "foregroundColor": "string"
    },
    "security": {
    "enableOneTimeUse": true,
    "disableIOSPassSharing": true,
    "disablePassLinkSharing": true,
    "disableMultipleHolders": true,
    "enableSecurityAnimation": true,
    "enableRotatingBarcode": true
    },
    "passBuilderPassTemplateId": "string",
    "strip": "string",
    "PKTextAlignmentLeft": "CHAIR",
    "PKTextAlignmentCenter": "ROW",
    "PKTextAlignmentRight": "INACTIVE",
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }

    API news, once a month

    New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

    Report a technical problem

    An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

    For a fast answer, include:

    • The method and endpoint (e.g. POST /clients)
    • The error code returned (errorCode) and the body sent
    • The date and time of the call
    • The identifiers involved (customer, template, pass)

    Never include an API token or a password.

    AI assistant

    Beta

    Loading…

    AI-generated answers (Claude): double-check important details.

    Sign in to use the assistant