Skip to main content

UpdateWalletSettingsDto

apiKeystring

API key for wallet settings

communicationChannelstring

Communication channel preference

Possible values: [email, sms, all]

smsConfig object

SMS configuration

smsTitlestringrequired

SMS title

usernamestringrequired

SMS username

passwordstringrequired

SMS password

emailConfig object

Email configuration

typestringrequired

Email service type

Default value: ses
portnumberrequired

Email service port

auth objectrequired

Email authentication credentials

userstringrequired

Email auth username

passstringrequired

Email auth password

hoststringrequired

Email service host

communicationRules object[]
  • Array [
  • notificationTypestringrequired

    Possible values: [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]

    smsbooleanrequired
    emailbooleanrequired
    notificationbooleanrequired
  • ]
  • UpdateWalletSettingsDto
    {
    "apiKey": "string",
    "communicationChannel": "email",
    "smsConfig": {
    "smsTitle": "string",
    "username": "string",
    "password": "string"
    },
    "emailConfig": {
    "type": "ses",
    "port": 0,
    "auth": {
    "user": "string",
    "pass": "string"
    },
    "host": "string"
    },
    "communicationRules": [
    {
    "notificationType": "NEW_LOYALTY",
    "sms": true,
    "email": true,
    "notification": true
    }
    ]
    }

    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