Skip to main content

BulkUpdateTransitPassesDto

webhookUrlstring

Optional webhook URL to receive notification when operation completes. Auth headers: append #headers=Authorization:Bearer%20token

Example: https://example.com/webhook#headers=Authorization:Bearer%20token
forceSyncboolean

Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.

Default value: false
items object[]required

Array of transit passes to update

Possible values: >= 1, <= 5000

  • Array [
  • departureDatestring

    ISO 8601 calendar date (YYYY-MM-DD)

    Example: 2000-01-01
    arrivalDatestring

    ISO 8601 calendar date (YYYY-MM-DD)

    Example: 2000-01-01
    departureTimestring

    24-hour HH:mm

    Possible values: Value must match regular expression ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

    Example: 00:00
    arrivalTimestring

    24-hour HH:mm

    Possible values: Value must match regular expression ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

    Example: 01:00
    originStationCodestring

    Possible values: <= 3 characters

    Example: str
    destinationStationCodestring

    Possible values: <= 3 characters

    Example: str
    expirationDatestring
    Example: 2000-01-01
    passIdstringrequired

    Transit pass ID

    Example: 507f1f77bcf86cd799439011
    firstNamestring
    lastNamestring
    emailstring<email>
    phoneNumberstring
    barcodestring
    flightNumberstring
    gatestring
    seatstring
    originNamestring

    Possible values: <= 13 characters

    destinationNamestring

    Possible values: <= 13 characters

    tripNumberstring
    tarifstring
    customBackFields object[]
  • Array [
  • keystring

    Auto-generated server-side (slug derived from label + position index). Clients should NOT send this field — it is ignored and always regenerated.

    labelstringrequired
    valuestringrequired
    typeobjectrequired
  • ]
  • enableSendEmailOrSmsboolean
    Default value: false
  • ]
  • BulkUpdateTransitPassesDto
    {
    "webhookUrl": "https://example.com/webhook#headers=Authorization:Bearer%20token",
    "forceSync": false,
    "items": [
    {
    "departureDate": "2000-01-01",
    "arrivalDate": "2000-01-01",
    "departureTime": "00:00",
    "arrivalTime": "01:00",
    "originStationCode": "str",
    "destinationStationCode": "str",
    "expirationDate": "2000-01-01",
    "passId": "507f1f77bcf86cd799439011",
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "phoneNumber": "string",
    "barcode": "string",
    "flightNumber": "string",
    "gate": "string",
    "seat": "string",
    "originName": "string",
    "destinationName": "string",
    "tripNumber": "string",
    "tarif": "string",
    "customBackFields": [
    {
    "key": "string",
    "label": "string",
    "value": "string",
    "type": {}
    }
    ],
    "enableSendEmailOrSms": false
    }
    ]
    }

    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