{ "item": [ { "id": "2c317e1c-3ef4-40cd-bb11-b4076d69d1ab", "name": "Auth", "description": { "content": "Get a token and manage your password.", "type": "text/plain" }, "item": [ { "id": "32e35082-6cb7-49ec-9621-6c5811e047e7", "name": "Log in and get a token", "request": { "name": "Log in and get a token", "description": { "content": "Exchanges a username (`username`) and password for a JWT access token, returned in `token`. Then send this token in the `Authorization: Bearer ` header of every request.\n\n:::info[Good to know]\n\n- Errors: wrong password gives `401 UNAUTHORIZED`, unknown `username` gives `404 MODEL_NOT_FOUND`, a non-administrator account with no wallet gives `400 VALIDATION_ERROR`. The JWT expires: for a server-to-server integration, use a wallet token created with `POST /wallets/tokens` instead of storing a password.\n\n:::", "type": "text/plain" }, "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5aaeddcb-3905-4195-a161-9dd46a8ebcbd", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b691fa70-4be0-4f42-81fb-835146b19c37", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/auth/login\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc754b55-b4a8-4183-9e0a-3760dea5738e", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/auth/login\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1adce3-b59d-4f9c-8409-9213f3771d5f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/auth/login\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9cd2bbb-c0ab-4c1d-9fe8-1b4551d6c99c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/auth/login\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "254e5ef3-05f6-45f5-9fa5-854e10e0ec7f", "name": "Update the password", "request": { "name": "Update the password", "description": { "content": "Changes the password of the authenticated account, after checking the current password (`currentPassword`). Returns no content on success.\n\n:::info[Good to know]\n\n- A wrong `currentPassword` gives `403 FORBIDDEN`. `newPassword` must be at least 4 characters. JWTs and wallet tokens already issued stay valid: delete wallet tokens with `DELETE /wallets/tokens/{id}` if needed.\n\n:::", "type": "text/plain" }, "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9339d9d-7fde-4f83-8bdd-f8570548db1d", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c82ee458-ccf7-4756-8534-3267d2e88e95", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/auth/password\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58515bdb-368e-4d2d-8237-86761f2ebca2", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/auth/password\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29ae1f64-cd1d-4508-b5b6-4d14a07d769c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/auth/password\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15a84df-006a-4261-b747-24cc4849a771", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/auth/password\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ac9eacb-020f-4bad-b0b3-d04871c9e5d8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "auth", "password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"string\",\n \"newPassword\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/auth/password\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9f25c00a-f970-44e6-a24c-9589489cbf09", "name": "Wallets", "description": { "content": "Your eldo wallet workspace and its access tokens.", "type": "text/plain" }, "item": [ { "id": "d6156fd5-a297-40e8-ab36-1709ecd8d45a", "name": "Create a wallet", "request": { "name": "Create a wallet", "description": { "content": "Creates a new wallet with its contact details, logos and terms and conditions. Restricted to administrator accounts; integrations use `GET /wallets` and `PATCH /wallets` on their own wallet.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `termsAndConditions.customUrl` is required when `type` is `URL`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "string", "type": "text", "description": "(Required) " }, { "key": "webHookUrl", "value": "string", "type": "text", "description": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token" }, { "key": "icon", "type": "file", "description": "" }, { "key": "logo", "type": "file", "description": "" }, { "key": "androidLogo", "type": "file", "description": "" }, { "key": "identifier", "value": "string", "type": "text", "description": "" }, { "key": "identifierQr", "value": "string", "type": "text", "description": "" }, { "key": "address", "value": "string", "type": "text", "description": "" }, { "key": "website", "value": "string", "type": "text", "description": "" }, { "key": "servicePhone", "value": "string", "type": "text", "description": "" }, { "key": "businessPhone", "value": "string", "type": "text", "description": "" }, { "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text", "description": "" }, { "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text", "description": "" }, { "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text", "description": "" }, { "key": "rootDomain", "value": "string", "type": "text", "description": "" }, { "key": "timezone", "value": "string", "type": "text", "description": "" }, { "key": "allowedPasses", "value": "[\"STORE_CARD\",\"BOARDING_PASS\"]", "type": "text", "description": "" }, { "key": "expiredCleanupEnabled", "value": "false", "type": "text", "description": "" } ] } }, "response": [ { "id": "11173e37-32d2-47f6-b6fa-791191cc9698", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"tiktok\": \"string\",\n \"twitter\": \"string\",\n \"youtube\": \"string\",\n \"snapchat\": \"string\",\n \"pinterest\": \"string\",\n \"reddit\": \"string\",\n \"whatsapp\": \"string\",\n \"telegram\": \"string\"\n },\n \"additionalContacts\": [\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"EMAIL\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"PHONE\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": \"NONE\",\n \"customUrl\": \"string\",\n \"pdfUrl\": \"string\"\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2010-08-30T14:32:46.144Z\",\n \"updatedAt\": \"2002-07-14T22:00:44.780Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2c475bb-2377-4e3b-90b6-6c9b038ac579", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d993f70-14b7-4ee6-ba4d-d1675b9c6dad", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d7abca6-5e8c-4bca-ab22-655534fb64cf", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df677a2f-bb96-4884-bf5c-7609c4ffc506", "name": "`PASSBUILDER_IDENTITY_INCOMPLETE`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"PassBuilder identity is incomplete or contradictory. Repair the wallet before continuing.\",\n \"errorCode\": \"409:PASSBUILDER_IDENTITY_INCOMPLETE\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7497705-c01c-4c0c-bfc6-bc1578950545", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b26fe23a-5709-4e67-b446-b71bc10b10ff", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f4fb970-1716-4eac-92ff-4668ff37fbd4", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"BOARDING_PASS\",\"EVENT_TICKET\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ac62c1a-b38c-4147-9da9-6689cdf4877e", "name": "Update the wallet", "request": { "name": "Update the wallet", "description": { "content": "Updates the wallet of the token used: name, contact details, social networks, logos, time zone, webhooks or terms and conditions. Only the fields you send are changed; accepts `multipart/form-data` (for images) or `application/json`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `termsAndConditions.customUrl` is required when `type` is `URL`.\n- Any real change updates the installed passes in the background: loyalty cards every time, the other pass types when a field they display changes (name, logos, phones…). Loyalty card holders are notified according to the `UPDATE_LOYALTY` rule, which uses credits; credit is checked before anything is saved (`INSUFFICIENT_CREDIT`, or `409 INSUFFICIENT_CREDIT_PARTIAL`, which you can override with `acceptPartialDelivery: true`). A request that changes nothing triggers nothing.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "webHookUrl", "value": "string", "type": "text", "description": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token" }, { "key": "icon", "type": "file", "description": "" }, { "key": "logo", "type": "file", "description": "" }, { "key": "androidLogo", "type": "file", "description": "" }, { "key": "name", "value": "string", "type": "text", "description": "" }, { "key": "identifier", "value": "string", "type": "text", "description": "" }, { "key": "identifierQr", "value": "string", "type": "text", "description": "" }, { "key": "address", "value": "string", "type": "text", "description": "" }, { "key": "website", "value": "string", "type": "text", "description": "" }, { "key": "servicePhone", "value": "string", "type": "text", "description": "" }, { "key": "businessPhone", "value": "string", "type": "text", "description": "" }, { "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text", "description": "" }, { "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"EMAIL\"}]", "type": "text", "description": "" }, { "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text", "description": "" }, { "key": "rootDomain", "value": "string", "type": "text", "description": "" }, { "key": "timezone", "value": "string", "type": "text", "description": "" }, { "key": "allowedPasses", "value": "[\"GENERIC\",\"COUPON\"]", "type": "text", "description": "" }, { "key": "expiredCleanupEnabled", "value": "false", "type": "text", "description": "" } ] } }, "response": [ { "id": "abe8c1a0-b2a2-48a7-b307-c931a6302a8e", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"tiktok\": \"string\",\n \"twitter\": \"string\",\n \"youtube\": \"string\",\n \"snapchat\": \"string\",\n \"pinterest\": \"string\",\n \"reddit\": \"string\",\n \"whatsapp\": \"string\",\n \"telegram\": \"string\"\n },\n \"additionalContacts\": [\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"EMAIL\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"PHONE\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": \"NONE\",\n \"customUrl\": \"string\",\n \"pdfUrl\": \"string\"\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2010-08-30T14:32:46.144Z\",\n \"updatedAt\": \"2002-07-14T22:00:44.780Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f7a4d3-6531-4be8-a21a-db24360916fb", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `INSUFFICIENT_CREDIT`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ba2c2f2-9830-4076-8cc5-86aefc6b418f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83579c7d-9d12-4f72-adb0-b44b98fb4c59", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a571fdd-6dba-4f16-a626-04dfac3e8997", "name": "`MODEL_NOT_FOUND` · `WALLET_UPDATE_FAILED`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c44361f-65d5-45ba-b2fc-e3f72b704ffc", "name": "`INSUFFICIENT_CREDIT_PARTIAL` · `PASSBUILDER_IDENTITY_PROVISIONING` · `PASSBUILDER_IDENTITY_INCOMPLETE`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Some channels do not have enough credit to notify every client. Confirm to send only on the channels that do.\",\n \"errorCode\": \"409:INSUFFICIENT_CREDIT_PARTIAL\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ab982e-1821-4e15-92e8-878d818aec8b", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afb9effb-09c8-4a16-87fc-0e08078303e8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0484697-5fa6-4d49-b902-7d886c6931fb", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webHookUrl", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "icon", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "logo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "androidLogo", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifier", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "identifierQr", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "address", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "servicePhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "businessPhone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "socialMedia", "value": "{\"linkedin\":\"string\",\"tiktok\":\"string\",\"twitter\":\"string\",\"facebook\":\"string\",\"instagram\":\"string\",\"youtube\":\"string\",\"snapchat\":\"string\",\"pinterest\":\"string\",\"reddit\":\"string\",\"whatsapp\":\"string\",\"telegram\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalContacts", "value": "[{\"title\":\"string\",\"value\":\"string\",\"kind\":\"URL\"},{\"title\":\"string\",\"value\":\"string\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "termsAndConditions", "value": "{\"type\":\"PDF\",\"customUrl\":\"https://example.com/terms\",\"pdfFile\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "rootDomain", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "timezone", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "allowedPasses", "value": "[\"TRANSIT\",\"TRANSIT\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expiredCleanupEnabled", "value": "false", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d8cd311-5869-46f6-9079-fcca244b88e5", "name": "Get the wallet", "request": { "name": "Get the wallet", "description": { "content": "Returns the wallet linked to the token used: name, contact details, social networks, logos, time zone, allowed pass types and terms and conditions. Use it to check your token and the wallet configuration.\n\n:::info[Good to know]\n\n- `webHookUrl` is returned without the `#headers=…` part of each URL: webhook authentication headers are never sent back.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a7db533a-f492-4488-817f-c28494c87d71", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"tiktok\": \"string\",\n \"twitter\": \"string\",\n \"youtube\": \"string\",\n \"snapchat\": \"string\",\n \"pinterest\": \"string\",\n \"reddit\": \"string\",\n \"whatsapp\": \"string\",\n \"telegram\": \"string\"\n },\n \"additionalContacts\": [\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"EMAIL\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"PHONE\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": \"NONE\",\n \"customUrl\": \"string\",\n \"pdfUrl\": \"string\"\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2010-08-30T14:32:46.144Z\",\n \"updatedAt\": \"2002-07-14T22:00:44.780Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409d0e7c-d3bd-4ae6-8023-b3dbb5efa7ca", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053d94d4-9e82-443c-acc1-3a278a130c70", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8e69b73-7933-4fde-96fe-5281c5b14cc9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c17e44d-2987-4039-8031-9c1e1b42522d", "name": "Create a wallet token", "request": { "name": "Create a wallet token", "description": { "content": "Creates an access token for the wallet, to use instead of a JWT for server-to-server integrations. The token is returned in the `token` field; `expiresAt` is optional.\n\n:::info[Good to know]\n\n- Requires a wallet manager account: an administrator JWT gets `400 VALIDATION_ERROR`. `expiresAt` (ISO 8601 date) is optional; without it the token never expires. The token gives the same access as the wallet's manager account: keep it server-side.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a48c0ad5-c203-4d37-a3f8-2a561916fa11", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tokenable\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"TRANSIT\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2014-02-03T20:40:06.537Z\",\n \"updatedAt\": \"2012-10-16T15:32:04.898Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"token\": \"string\",\n \"tokenableType\": \"WALLET\",\n \"_id\": \"string\",\n \"createdAt\": \"1963-04-21T13:55:11.763Z\",\n \"updatedAt\": \"1947-01-22T13:32:22.230Z\",\n \"expiresAt\": \"1950-10-26T04:46:14.246Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f51963a-c14e-40ee-b01c-081fdc5053b4", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b69ebb-101a-49fe-8bfd-9cec2e0ec9bb", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2360e66-2a7e-434f-8108-e921d433d5f6", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8d563dc-8e1e-47e6-8e8f-9af0ea9304cc", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"expiresAt\": \"1959-10-17T16:28:24.607Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f633996e-0aed-407f-81f1-9c5954d02b81", "name": "List wallet tokens", "request": { "name": "List wallet tokens", "description": { "content": "Lists, page by page, the access tokens created for the wallet, with their expiry date if any.\n\n:::info[Good to know]\n\n- `expiresAt` is `null` for a token that never expires. Expired tokens are rejected (`401 UNAUTHORIZED`) and removed automatically.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Number of tokens per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e5fc2d24-5ca8-444f-b741-d9d9d6c3edbe", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"tokenable\": {\n \"value\": \"\"\n },\n \"token\": \"string\",\n \"tokenableType\": \"WALLET\",\n \"_id\": \"string\",\n \"createdAt\": \"1951-08-08T06:57:54.970Z\",\n \"updatedAt\": \"1958-01-25T07:10:50.739Z\",\n \"expiresAt\": \"1956-09-04T22:30:05.957Z\"\n },\n {\n \"tokenable\": {\n \"value\": \"\"\n },\n \"token\": \"string\",\n \"tokenableType\": \"USER\",\n \"_id\": \"string\",\n \"createdAt\": \"1999-07-10T04:20:09.703Z\",\n \"updatedAt\": \"1959-07-24T07:24:24.109Z\",\n \"expiresAt\": \"2022-08-05T16:53:29.731Z\"\n }\n ],\n \"totalDocs\": 4381.456734483169,\n \"limit\": 1743.2531603903167,\n \"totalPages\": 8427.432640016812,\n \"pagingCounter\": 2997.5017103349687,\n \"hasPrevPage\": false,\n \"hasNextPage\": false,\n \"page\": 8420.962016277113,\n \"prevPage\": 8711.338383438779,\n \"nextPage\": 6586.473885125303\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a26b944-0d51-4982-b2ce-d1e3f079c2b3", "name": "`VALIDATION_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "932c1058-0517-4d06-9fb8-3ca6f9786c2b", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ae3d752-2e8b-44e2-9524-bec87444bdd3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a74b4251-9f0b-4c67-b26a-4ca35dd96bf6", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets/tokens\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46e24e17-9d91-40be-b8af-cce435008835", "name": "Delete a wallet token", "request": { "name": "Delete a wallet token", "description": { "content": "Deletes (revokes) a wallet access token. Returns no content on success.\n\n:::info[Good to know]\n\n- Revocation is immediate: later requests with this token get `401 UNAUTHORIZED`. A token that does not belong to your wallet gives `404 MODEL_NOT_FOUND`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "877108fe-96df-4373-9707-c05b68c760f2", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e30261e-8969-4d62-8f77-410c213a8c10", "name": "`VALIDATION_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets/tokens/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7274e432-73b6-4984-b436-3952ae19d011", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets/tokens/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a12f47ad-ac86-4142-be76-df7f69332b98", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets/tokens/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25cc590c-c50d-4dd3-b265-8f9b488ea272", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallets/tokens/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94ba55dc-ea15-4efe-8bc2-ec5949940ac4", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "tokens", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Token ID (the `_id` returned by `GET /wallets/tokens`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets/tokens/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24ddaee0-0238-4cf9-a855-b7ffe7ae980e", "name": "Update the pass builder configuration", "request": { "name": "Update the pass builder configuration", "description": { "content": "Resynchronises the wallet with the pass generator: completes its configuration if needed, then restarts the update of all its installed passes. No request body; returns the wallet.\n\n:::info[Good to know]\n\n- Restarts, in the background, the update of every installed pass of the wallet (events, hotels, transits, loyalty cards); loyalty card holders may be notified according to the `UPDATE_LOYALTY` rule. `409 PASSBUILDER_IDENTITY_PROVISIONING` means a setup is already in progress: retry shortly.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH" }, "response": [ { "id": "4e25b2b9-1efa-4395-95f3-2b0d5b875a1a", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"tiktok\": \"string\",\n \"twitter\": \"string\",\n \"youtube\": \"string\",\n \"snapchat\": \"string\",\n \"pinterest\": \"string\",\n \"reddit\": \"string\",\n \"whatsapp\": \"string\",\n \"telegram\": \"string\"\n },\n \"additionalContacts\": [\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"EMAIL\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"PHONE\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": \"NONE\",\n \"customUrl\": \"string\",\n \"pdfUrl\": \"string\"\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2010-08-30T14:32:46.144Z\",\n \"updatedAt\": \"2002-07-14T22:00:44.780Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5f8d85f-48e1-4a8c-97ab-0598938f0f19", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0822318-745e-4499-b02a-5834d2dda3d4", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0c709ce-fcee-4800-9180-af57a0f59558", "name": "`WALLET_UPDATE_FAILED`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Failed to update wallet\",\n \"errorCode\": \"404:WALLET_UPDATE_FAILED\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49d11f4f-a714-4d1d-a23d-b565370d2c9e", "name": "`PASSBUILDER_IDENTITY_PROVISIONING` · `PASSBUILDER_IDENTITY_INCOMPLETE`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"PassBuilder identity provisioning is already in progress. Retry shortly.\",\n \"errorCode\": \"409:PASSBUILDER_IDENTITY_PROVISIONING\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b1a69ce-09f0-4625-a58a-383564f9a980", "name": "`WALLET_UPDATE_ERROR` · `UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"An error occurred while updating the wallet\",\n \"errorCode\": \"500:WALLET_UPDATE_ERROR\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b9d6a3-ac11-45c8-ac99-1be150a4120c", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "pass-builder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/wallets/pass-builder\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "897f010c-b669-4293-bab6-34d30ed612ef", "name": "Update the terms and conditions", "request": { "name": "Update the terms and conditions", "description": { "content": "Sets the wallet's terms and conditions: none (`type: NONE`), a link (`type: URL` with `customUrl`) or a PDF file of up to 5 MB (`type: PDF` with `pdfFile`, as multipart). Returns the updated wallet.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `customUrl` is required when `type` is `URL`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "PDF", "type": "text", "description": "Type of terms and conditions (This can only be one of PDF,URL,NONE)" }, { "key": "customUrl", "value": "https://example.com/terms", "type": "text", "description": "Custom URL for terms and conditions (maps to generalRoleUrl)" }, { "key": "pdfFile", "type": "file", "description": "" } ] } }, "response": [ { "id": "a705d97d-357c-41bf-beb6-b969eb4e8e44", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"tiktok\": \"string\",\n \"twitter\": \"string\",\n \"youtube\": \"string\",\n \"snapchat\": \"string\",\n \"pinterest\": \"string\",\n \"reddit\": \"string\",\n \"whatsapp\": \"string\",\n \"telegram\": \"string\"\n },\n \"additionalContacts\": [\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"EMAIL\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\",\n \"kind\": \"PHONE\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": \"NONE\",\n \"customUrl\": \"string\",\n \"pdfUrl\": \"string\"\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2010-08-30T14:32:46.144Z\",\n \"updatedAt\": \"2002-07-14T22:00:44.780Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d9ac6bf-96d8-4595-b044-fddaddeb0b4c", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2521e25-34a5-44ce-a668-2adc4d2298a3", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5424ebee-2fd0-458e-bf13-c45d00baf9a4", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94a47fb3-ba93-4910-a78c-97ab3c21c5b7", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853d6a89-2849-464f-ac90-0d173efea70b", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af339d6-0191-496e-bca7-b5142401a00f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallets", "terms-and-conditions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Type of terms and conditions (This can only be one of PDF,URL,NONE)", "type": "text/plain" }, "key": "type", "value": "PDF", "type": "text" }, { "description": { "content": "Custom URL for terms and conditions (maps to generalRoleUrl)", "type": "text/plain" }, "key": "customUrl", "value": "https://example.com/terms", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "pdfFile", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallets/terms-and-conditions\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5ce862a5-5295-4f48-9d8d-c238f79fedb6", "name": "Wallet Settings", "description": { "content": "Delivery settings (email, SMS) and preferences.", "type": "text/plain" }, "item": [ { "id": "9e2a68f3-ce47-4406-8684-81abadfb2695", "name": "Get wallet settings", "request": { "name": "Get wallet settings", "description": { "content": "Returns the wallet's sending settings: communication channel (`communicationChannel`), email and SMS configuration, and sending rules per notification type (`communicationRules`).\n\n:::info[Good to know]\n\n- `communicationChannel` turns email (`email`), SMS (`sms`) or both (`all`) on for the whole wallet; push notifications do not depend on it. A notification type with no entry in `communicationRules` is not blocked on any channel.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "127a92de-bbec-4626-9fa6-6bf892c7e26c", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"COUPON\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1988-08-01T08:07:44.229Z\",\n \"updatedAt\": \"2015-08-29T14:45:36.356Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"apiKey\": \"string\",\n \"communicationChannel\": \"all\",\n \"communicationRules\": [\n {\n \"notificationType\": \"WELCOME_EXTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": false,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": true,\n \"notification\": false\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1990-12-18T19:11:43.618Z\",\n \"updatedAt\": \"1999-07-22T10:28:48.714Z\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"SMTP\",\n \"port\": 2211.195742355729,\n \"auth\": {\n \"user\": \"string\",\n \"pass\": \"string\"\n },\n \"host\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad310f7e-c001-4826-9f96-8a474f7be07c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d09628b-47cc-4c19-9af4-a9b428358f13", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26929c9f-3d63-44e4-856a-304bbaea562f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4f9c673-c536-4245-8332-79f8ebe6bcbd", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1724a838-341e-4d15-82d7-983f879e7bd1", "name": "Update wallet settings", "request": { "name": "Update wallet settings", "description": { "content": "Updates the wallet's sending settings: communication channel, SMS or email configuration, and sending rules per notification type. Only the fields you send are changed; returns the updated settings.\n\n:::info[Good to know]\n\n- `communicationRules` replaces the whole list: send every rule (`notificationType` with `email`, `sms`, `notification`). Switching `communicationChannel` to `sms` or `all` requires an SMS configuration already saved (`smsConfig` with credentials), otherwise `400 SMS_CONFIG_REQUIRED`: save `smsConfig` first, then change the channel.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 2521.683564519839,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"UPDATE_TRANSIT\",\n \"sms\": false,\n \"email\": false,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37765688-657d-4130-a8e4-1246f1fc2d3c", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"EVENT_TICKET\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1962-01-16T01:24:23.923Z\",\n \"updatedAt\": \"2020-03-28T06:48:05.338Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"apiKey\": \"string\",\n \"communicationChannel\": \"all\",\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_EVENT\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"WELCOME_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1985-12-12T02:28:20.304Z\",\n \"updatedAt\": \"1947-06-23T12:13:19.928Z\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"SMTP\",\n \"port\": 337.8079071370177,\n \"auth\": {\n \"user\": \"string\",\n \"pass\": \"string\"\n },\n \"host\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9f9bb20-7d71-44a7-9a2f-0fd3320581ee", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `SMS_CONFIG_REQUIRED`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93ae4dc1-bf67-4e9c-a96a-08e8d8d121cf", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6279eb1a-a822-4072-bbd3-cba8adc364ab", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58598292-454c-4922-a514-2af837f82692", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe153b4a-1552-4061-84be-fb4acf673091", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"string\",\n \"communicationChannel\": \"sms\",\n \"smsConfig\": {\n \"smsTitle\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n },\n \"emailConfig\": {\n \"type\": \"ses\",\n \"port\": 4486.087202762632,\n \"auth\": {\n \"description\": \"Email authentication credentials\",\n \"value\": \"\"\n },\n \"host\": \"string\"\n },\n \"communicationRules\": [\n {\n \"notificationType\": \"NEW_LOYALTY\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-settings\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "22d3b563-6045-458a-9a3a-c9322a94d439", "name": "Wallet Locations", "description": { "content": "Places that surface passes on the lock screen.", "type": "text/plain" }, "item": [ { "id": "c49891d6-7bb6-43be-9e75-9f638a700499", "name": "List locations", "request": { "name": "List locations", "description": { "content": "Lists, page by page, the wallet's locations (coordinates and texts shown nearby).\n\n:::info[Good to know]\n\n- A wallet has at most 10 locations. They apply to the wallet's loyalty card.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial match on the location ID (`_id`)." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of locations per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7c28d3a3-e0e6-4f66-9475-de13451d25ed", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4109c626-8f5c-4143-ac71-738c6990d501", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c915a8f-3424-4e34-9684-7edac04ba890", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4365e739-1854-4276-b13e-ae1ad35f7088", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c4f9305-f851-4abd-a8d8-8ab74bf54ba8", "name": "Create a location", "request": { "name": "Create a location", "description": { "content": "Adds a location to the wallet: `latitude`, `longitude`, and one text (`relevantText`) or texts per time slot (`relevantTextList`). Near this place, the loyalty card can appear on the lock screen with this text.\n\n:::info[Good to know]\n\n- At most 10 locations per wallet: beyond that, `400 MAX_WALLET_LOCATIONS_REACHED`. The location is added to the loyalty card template without notifying holders. Each `relevantTextList` slot (`startTime`, `endTime` as `HH:mm`, at least 30 minutes) shows its `relevantText` during that time range.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 9264.568926844013,\n \"latitude\": 8618.249662079032,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4c43483-c409-45bd-ab65-680da8bbcca6", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"GENERIC\",\n \"HOTEL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1975-04-09T11:23:11.106Z\",\n \"updatedAt\": \"1992-10-22T21:25:34.629Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"longitude\": 1219.5736255098577,\n \"latitude\": 415.5577552749712,\n \"relevantText\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1960-03-15T08:45:29.975Z\",\n \"updatedAt\": \"2007-06-19T12:31:46.714Z\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\",\n \"status\": \"INACTIVE\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\",\n \"status\": \"INACTIVE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39420771-f463-48cf-8132-9789c4834f5b", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `MAX_WALLET_LOCATIONS_REACHED`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e1d97a-9aee-4f31-b529-530e61fdf9b1", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce6bc52-1a3d-49db-9c4f-3b4a5d09633e", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3abf46b5-0d75-4b69-8ac3-49b2d6c3e477", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9beff358-ce26-4b0b-9241-995222003bc5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-locations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"longitude\": 1532.5268449095386,\n \"latitude\": 4795.875503737628,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-locations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82037d34-550d-4fb7-ab9a-68c775f50bd1", "name": "Update a location", "request": { "name": "Update a location", "description": { "content": "Changes the coordinates or texts of a location. Returns the updated location.\n\n:::info[Good to know]\n\n- A `relevantTextList` you send replaces the existing list. The loyalty card template is updated without notifying holders.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 63.992022959904475,\n \"latitude\": 1930.4533053703365,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "340e035b-3914-43a5-ae84-0df0f5854c8b", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc29915-cd6e-42c6-9548-e39f44bbdbaa", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ae041b5-4570-4d15-99f7-a7cbf2bd73b2", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5684364f-3b55-4926-a544-483c7cb9d273", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c702f401-b1e8-4974-ba27-cc6f656fbcdf", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f986eb-a518-4efd-b8b5-df8ca340219c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"longitude\": 6735.742003095091,\n \"latitude\": 2595.396293294814,\n \"relevantText\": \"string\",\n \"relevantTextList\": [\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n },\n {\n \"relevantText\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c853ab17-2ddd-449b-8f81-89c343f1e27f", "name": "Delete a location", "request": { "name": "Delete a location", "description": { "content": "Deletes a location from the wallet. Returns `{\"success\": true}`.\n\n:::info[Good to know]\n\n- The location is removed from the loyalty card template without notifying holders, and frees a slot of the 10 allowed.\n\n:::", "type": "text/plain" }, "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "344d8b49-21f4-4b1d-b064-0b13799b88d0", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a0b18bd-87cb-4f35-b240-c5515c1945a0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb58441-2470-4f7f-a6ec-781821a50fde", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1006532f-80c9-4fce-ad5a-3e0ba1daddbf", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c71a02-44c9-4916-86c8-c4a7f5283523", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "wallet-locations", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Location ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/wallet-locations/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f95a789d-d870-4bac-944f-4cae61aa0a68", "name": "Store Cards", "description": { "content": "The wallet's loyalty card (template).", "type": "text/plain" }, "item": [ { "id": "b8f4a576-a166-43cd-87b6-83cc180c06b4", "name": "Get the store card", "request": { "name": "Get the store card", "description": { "content": "Returns the wallet's store card, the template shared by all your clients' loyalty cards: card type, design, texts, gain unit and validity rules. Each wallet has a single store card.", "type": "text/plain" }, "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fc4ca70b-08cc-4105-90b9-95d1dc612214", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1955-10-23T04:36:31.398Z\",\n \"updatedAt\": \"1970-09-17T04:26:41.773Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"NONE\",\n \"descriptions\": [\n {\n \"title\": \"string\",\n \"value\": \"string\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": \"NO_EXPIRATION\",\n \"expirationDate\": \"1998-03-22T08:29:08.269Z\",\n \"expirationAfterPeriod\": \"string\",\n \"expirationPeriodType\": \"YEARS\",\n \"expirationOption\": \"END_OF_MONTH\"\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"USD\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2008-09-22T15:38:26.941Z\",\n \"updatedAt\": \"1954-01-21T08:18:31.214Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"ADMISSION_DATE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": \"TYPE\",\n \"valueEnum\": \"INACTIVE\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "411c12a2-26a1-49de-a6ac-05a93bcdf045", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b78e7a17-e0d3-44ee-b722-9014383e2a17", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5c50c31-7079-48e0-a7fb-d907f2ab4666", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42b6d8cd-7469-47bd-847c-984c3a98bcfb", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a93a662e-6fc1-4cf1-b7fe-cb781baa3168", "name": "Update the store card", "request": { "name": "Update the store card", "description": { "content": "Updates the wallet's store card template (design, texts, strip image, validity, gain unit…) and applies the changes to the cards already issued. Accepts `application/json` or `multipart/form-data` (to upload the `strip` image). Returns the updated store card.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "" }, { "key": "cardType", "value": "MEMBER_CARD", "type": "text", "description": " (This can only be one of STORE_CARD,MEMBER_CARD)" }, { "key": "programName", "value": "string", "type": "text", "description": "" }, { "key": "barcodeType", "value": "PDF_417", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1979-02-25T20:12:59.422Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text", "description": "" }, { "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text", "description": "" }, { "key": "openingHours", "value": "string", "type": "text", "description": "" }, { "key": "oneTimeToUse", "value": "false", "type": "text", "description": "" }, { "key": "sharingProhibited", "value": "false", "type": "text", "description": "" }, { "key": "sharingProhibitedAndroid", "value": "false", "type": "text", "description": "" }, { "key": "displayIdentifiant", "value": "true", "type": "text", "description": "" }, { "key": "displayWalletName", "value": "false", "type": "text", "description": "" }, { "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text", "description": "" }, { "key": "startRow", "value": "INACTIVE", "type": "text", "description": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)" }, { "key": "middleRow", "value": "CLUB", "type": "text", "description": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)" }, { "key": "endRow", "value": "ADMISSION_DATE", "type": "text", "description": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)" }, { "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"TYPE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text", "description": "" }, { "key": "gainLabel", "value": "POINTS", "type": "text", "description": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)" }, { "key": "gainUnit", "value": "MAD", "type": "text", "description": " (This can only be one of NONE,EURO,USD,MAD,POINTS)" } ] } }, "response": [ { "id": "e54af432-f695-4fa3-a871-40c2956259eb", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1955-10-23T04:36:31.398Z\",\n \"updatedAt\": \"1970-09-17T04:26:41.773Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"NONE\",\n \"descriptions\": [\n {\n \"title\": \"string\",\n \"value\": \"string\"\n },\n {\n \"title\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": \"NO_EXPIRATION\",\n \"expirationDate\": \"1998-03-22T08:29:08.269Z\",\n \"expirationAfterPeriod\": \"string\",\n \"expirationPeriodType\": \"YEARS\",\n \"expirationOption\": \"END_OF_MONTH\"\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"USD\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2008-09-22T15:38:26.941Z\",\n \"updatedAt\": \"1954-01-21T08:18:31.214Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"ADMISSION_DATE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": \"TYPE\",\n \"valueEnum\": \"INACTIVE\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed805f08-2e97-40ef-bedc-f7b5f3793cac", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `CLIENTS_EXIST_FOR_THIS_CARD_TYPE` · `INSUFFICIENT_CREDIT` · `OPERATION_TYPE_REQUIRED` · `OPERATION_TYPE_NOT_ALLOWED`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f65f10b-56cc-4c5d-b7d0-75e82f5dd97f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8536b2e5-e5f8-46b2-8de2-b8bf31a3b0b8", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b5608c4-9d69-4a9b-b6a1-848cf50288e1", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6abc4e47-e042-4b1c-832a-5a1a6b7cbbbf", "name": "`INSUFFICIENT_CREDIT_PARTIAL`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Some channels do not have enough credit to notify every client. Confirm to send only on the channels that do.\",\n \"errorCode\": \"409:INSUFFICIENT_CREDIT_PARTIAL\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "274a0878-318e-44d2-9d0c-12bd796b45a4", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eb3fcfd-20c8-4e03-bb56-3b09447d1ddb", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf17e8cb-322c-48b9-af08-907b288ea93a", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "store-cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of STORE_CARD,MEMBER_CARD)", "type": "text/plain" }, "key": "cardType", "value": "MEMBER_CARD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "programName", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "validity", "value": "{\"expirationType\":\"NO_EXPIRATION\",\"expirationDate\":\"1950-11-30T01:45:29.317Z\",\"expirationAfterPeriod\":\"string\",\"expirationOption\":\"AT_CREATION_DATE\",\"expirationPeriodType\":\"WEEKS\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "descriptions", "value": "[{\"title\":\"string\",\"value\":\"string\"},{\"title\":\"string\",\"value\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "openingHours", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "oneTimeToUse", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "sharingProhibitedAndroid", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayIdentifiant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayWalletName", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "keysHasChanged", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "startRow", "value": "GAIN", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "middleRow", "value": "MEMBER", "type": "text" }, { "description": { "content": " (This can only be one of CREATION_DATE,EXPIRATION_DATE,BIRTHDATE,GAIN,CLUB,ASSOCIATION,ORGANISATION,ENTREPRISE,N_LICENCE,N_ADHERENT,N_MEMBER,MEMBER,N_IMMATRICULATION,INACTIVE,ADMISSION_DATE)", "type": "text/plain" }, "key": "endRow", "value": "INACTIVE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"GAIN\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of GAIN,GAINS,CAGNOTE,POINTS)", "type": "text/plain" }, "key": "gainLabel", "value": "CAGNOTE", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "EURO", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/store-cards\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d782c99-8928-4960-94aa-20494bd2d29f", "name": "Get store card details", "request": { "name": "Get store card details", "description": { "content": "Returns a summary of the store card, handy for building a client form: card type (`cardType`), available client types (`clientTypes`), expiration date computed from the card's validity (`expirationDate`), card row contents (`startRow`, `middleRow`, `endRow`) and the wallet's communication channel. `isUnlimited` is `true` when the card never expires.", "type": "text/plain" }, "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0a984cfd-eb64-4137-8d8b-fbcb9dcee855", "originalRequest": { "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cardType\": \"MEMBER_CARD\",\n \"clientTypes\": [\n {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2002-09-29T13:01:24.832Z\",\n \"updatedAt\": \"1975-08-27T01:04:53.425Z\"\n },\n {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1992-04-16T10:45:14.658Z\",\n \"updatedAt\": \"1982-03-01T14:36:42.167Z\"\n }\n ],\n \"expirationDate\": \"1968-04-23T17:50:53.811Z\",\n \"startRow\": \"N_MEMBER\",\n \"middleRow\": \"ORGANISATION\",\n \"endRow\": \"BIRTHDATE\",\n \"communicationChannel\": \"all\",\n \"isUnlimited\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c182f72e-4834-4c16-a561-f11fef372b95", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/store-cards/details\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0873463-7a39-42ab-872c-d8c46d730137", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/store-cards/details\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8befbc06-b2f2-47a5-bfc0-314865e50015", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/store-cards/details\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "918c3faf-42a5-4a21-8c00-cd34410e4928", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "store-cards", "details" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/store-cards/details\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "97532b69-cf57-46b8-a2af-da883f7c4184", "name": "Clients", "description": { "content": "Loyalty card holders. Create, import, update, search.", "type": "text/plain" }, "item": [ { "id": "a8f7eb49-8116-4282-90dd-4a8b9552df55", "name": "Create a client", "request": { "name": "Create a client", "description": { "content": "Creates a client and their loyalty card from the wallet's store card template. Without `clientType`, the client gets the default type; without `barcode`, the client ID is used as the barcode (when the card shows one). Returns the client with their card details (`passId`, `passStatus`, `shortLink`).\n\n:::info[Good to know]\n\n- source (CRM|INTERNAL|EXTERNAL) is required. sendCard=true issues and sends the loyalty card. Emits the client.created webhook. Duplicate email or barcode gives 409.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc36a3e1-ce83-4a7e-961f-75b2c3f8a275", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"EXTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1975-05-27T23:11:47.071Z\",\n \"updatedAt\": \"1957-03-15T07:57:55.943Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2014-12-07T16:40:46.028Z\",\n \"updatedAt\": \"2025-12-21T03:43:01.725Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1991-10-10T17:09:37.746Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1964-08-11T17:48:46.696Z\",\n \"admissionDate\": \"1966-10-18T18:09:12.729Z\",\n \"gain\": 2673.699143691517,\n \"gainHistory\": [\n {\n \"gain\": 6679.283846044935,\n \"date\": \"1983-09-28T12:21:18.322Z\"\n },\n {\n \"gain\": 733.8777270093622,\n \"date\": \"2019-03-21T06:22:11.004Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"TRANSIT_TICKET\",\n \"sms\": true,\n \"email\": false,\n \"notification\": false\n },\n {\n \"notificationType\": \"EXPIRED_COMMUNICATION\",\n \"sms\": true,\n \"email\": false,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": true,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44acd499-4642-4891-956f-2bc3a31701aa", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a4614bc-d77a-41de-9f0b-3c861519ec88", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fa1826e-2473-4c17-a9b8-bfb56c79cda7", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ca289b-6312-40ca-9159-4ec16fab50a8", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48ff9914-eaa4-457b-ac45-59de54b26455", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53793237-f082-4abc-9752-add58efe1b39", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3kms@LdqgKo.wzc\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"2001-06-11T12:38:56.060Z\",\n \"birthDate\": \"1971-11-01T19:30:17.453Z\",\n \"admissionDate\": \"2019-06-02T00:24:50.642Z\",\n \"clientType\": \"string\",\n \"gain\": 8008.805637937384,\n \"companyName\": \"string\",\n \"sendCard\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "781a67b3-3ab3-49c7-af51-4abc3c367b37", "name": "List clients", "request": { "name": "List clients", "description": { "content": "Paginated list of the wallet's clients with the state of their loyalty card (`passStatus`, `deviceTypes`, `shortLink`). Combine full-text search (`search`), exact-match filters and the status filter to find a client or a segment.\n\n:::info[Good to know]\n\n- `firstName`, `lastName`, `email`, `barcode` and `phoneNumber` are exact-match filters; use `search` for a partial, case-insensitive match. The `status`, `createdAtStart` and sort parameters apply to the client's loyalty card.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "status", "value": "inactive", "description": "Loyalty card status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to combine several statuses." }, { "disabled": false, "key": "status", "value": "active", "description": "Loyalty card status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Repeat the parameter to combine several statuses." }, { "disabled": false, "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z", "description": "Only returns clients whose card was created on or after this date (ISO 8601)." }, { "disabled": false, "key": "email", "value": "Rs2ErEhJhlwTgD5@fGffk.grli", "description": "Exact client email." }, { "disabled": false, "key": "barcode", "value": "string", "description": "Exact client barcode." }, { "disabled": false, "key": "phoneNumber", "value": "string", "description": "Exact client phone number, as stored." }, { "disabled": false, "key": "firstName", "value": "string", "description": "Exact first name (case-sensitive). For a partial match, use `search`." }, { "disabled": false, "key": "lastName", "value": "string", "description": "Exact last name (case-sensitive). For a partial match, use `search`." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive partial match on first name, last name, email, barcode, phone number and client ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Loyalty card sort field: `createdAt` (default), `updatedAt`, `_id`, `status` or `expirationDate`. Any other value falls back to `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Clients per page, from `1` to `1000`. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at `1`. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "32d7f39d-1d39-4d9d-bb8a-74ef2de4eaeb", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "expired" }, { "key": "status", "value": "active" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "email", "value": "Rs2ErEhJhlwTgD5@fGffk.grli" }, { "key": "barcode", "value": "string" }, { "key": "phoneNumber", "value": "string" }, { "key": "firstName", "value": "string" }, { "key": "lastName", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"source\": \"CRM\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1954-04-05T20:18:26.210Z\",\n \"updatedAt\": \"1949-09-22T00:51:44.627Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"hotel\": {\n \"value\": \"\"\n }\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"2000-07-30T17:16:37.862Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1991-06-16T01:40:59.984Z\",\n \"admissionDate\": \"2004-09-24T17:05:21.505Z\",\n \"gain\": 2286.242115283741,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": false\n },\n {\n \"source\": \"CRM\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1960-06-16T15:44:01.109Z\",\n \"updatedAt\": \"2016-01-23T19:36:18.424Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"hotel\": {\n \"value\": \"\"\n }\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1977-04-11T06:41:25.158Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1965-01-03T22:18:10.798Z\",\n \"admissionDate\": \"2007-08-11T23:58:53.555Z\",\n \"gain\": 3946.5874251352575,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n }\n ],\n \"totalDocs\": 111.9221630928613,\n \"limit\": 3277.7894857631472,\n \"totalPages\": 6191.548500228306,\n \"pagingCounter\": 3059.8286983029357,\n \"hasPrevPage\": false,\n \"hasNextPage\": false,\n \"page\": 9520.266272563445,\n \"prevPage\": 2606.08323724286,\n \"nextPage\": 7738.624240639165\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a07392-09e1-44bb-9e54-d5dcb74647bd", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "expired" }, { "key": "status", "value": "active" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "email", "value": "Rs2ErEhJhlwTgD5@fGffk.grli" }, { "key": "barcode", "value": "string" }, { "key": "phoneNumber", "value": "string" }, { "key": "firstName", "value": "string" }, { "key": "lastName", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd075f8a-61f3-44fb-9f11-76699fa6c1d1", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "expired" }, { "key": "status", "value": "active" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "email", "value": "Rs2ErEhJhlwTgD5@fGffk.grli" }, { "key": "barcode", "value": "string" }, { "key": "phoneNumber", "value": "string" }, { "key": "firstName", "value": "string" }, { "key": "lastName", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7788064c-c737-4db1-8d36-d2ea6bb20227", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "expired" }, { "key": "status", "value": "active" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "email", "value": "Rs2ErEhJhlwTgD5@fGffk.grli" }, { "key": "barcode", "value": "string" }, { "key": "phoneNumber", "value": "string" }, { "key": "firstName", "value": "string" }, { "key": "lastName", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3db2a0b3-8331-431a-a5b1-44fdb9c0c624", "name": "Bulk create clients", "request": { "name": "Bulk create clients", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Up to 5,000 clients per request. With `forceSync: true`, processing is synchronous and the response includes the results, but the request must contain fewer than 1,000 items (otherwise `400` `SYNC_EXECUTION_NOT_ALLOWED`). Each item is processed like `POST /clients` (card sent according to `sendCard`, `client.created` webhook); `webhookUrl` is called when the operation completes.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a5dc0ad1-849c-4aae-9f65-5818ec061b95", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cc222ba-3455-4a22-b4f0-e637c2fc45f3", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e7b036c-48fa-4063-b669-a7bbe5eae2ae", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539e2b6a-2c4c-4519-8040-523d9d2e7d0a", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f368f04c-ed53-4498-9b0d-ffc9ae35b24e", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53452e9c-de58-46c7-b3a1-280b688f48ac", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc1e8469-5462-417a-b1cc-4080d2f663c4", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"LhiouqKpKmC0@fidYvMVEikKHDNvckbr.rt\",\n \"source\": \"EXTERNAL\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1992-12-23T10:32:57.752Z\",\n \"birthDate\": \"1960-08-04T22:17:58.765Z\",\n \"admissionDate\": \"1958-02-21T19:46:19.883Z\",\n \"clientType\": \"string\",\n \"gain\": 4334.377110550425,\n \"companyName\": \"string\",\n \"sendCard\": true\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7a085c7-92dd-4cd5-981e-2d693b705351", "name": "Bulk update clients", "request": { "name": "Bulk update clients", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Up to 5,000 clients per request; each item carries the client `id` and is processed like `PATCH /clients/{id}` (`client.updated` webhook). With `forceSync: true`, processing is synchronous, limited to fewer than 1,000 items (otherwise `400` `SYNC_EXECUTION_NOT_ALLOWED`). `webhookUrl` is called when the operation completes.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "355e9134-341d-4486-b33a-6c1ed4cb779a", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad727862-e1f7-4d1f-8eaf-a7242f67f6be", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9470250b-480b-44de-8f79-c6a9bd056256", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "251acb65-42fa-435e-bbbe-c7edd2dbf3f0", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8fb0c75-a448-4acb-bd53-b50f8e2fb0f4", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a6f27e7-9bf0-4626-9a2b-badd944c4259", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f125cbaa-2fe2-47cb-b779-f44eff0c3569", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rxdxgiA4vXIvQ@hvhtUzLpxnLdUoHGpdMRe.rtga\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1972-10-06T08:47:01.850Z\",\n \"birthDate\": \"2011-05-05T21:40:05.832Z\",\n \"admissionDate\": \"2008-06-15T06:29:23.421Z\",\n \"clientType\": \"string\",\n \"gain\": 6719.805178105072,\n \"companyName\": \"string\",\n \"source\": \"EXTERNAL\",\n \"sendCard\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f4c5e36-e82b-4580-ad76-83c1c2ab885a", "name": "Bulk delete clients", "request": { "name": "Bulk delete clients", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Up to 5,000 client IDs in `ids`; each one is deleted like `DELETE /clients/{id}` (client and loyalty card deleted for good, `client.deleted` webhook). With `forceSync: true`, processing is synchronous, limited to fewer than 1,000 items (otherwise `400` `SYNC_EXECUTION_NOT_ALLOWED`). `webhookUrl` is called when the operation completes.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f5a72b8-da7c-4507-b853-1b5537e057cc", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7902fb0-1b06-4e0a-91a6-5dc8fff6d168", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90a29411-24cd-465d-ada6-d9a82f2a25b0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6cfef5e-6d29-4889-96cd-a4153037ee50", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d79500e-444d-4557-bc46-c3377009c2bf", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaa92807-87b0-4fc8-b604-522dd955ab83", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f262c786-4e54-4fff-93e9-9bd1eae0f828", "name": "Sync passes for all clients", "request": { "name": "Sync passes for all clients", "description": { "content": "Rebuilds the loyalty card of every client in the wallet from their stored data, to bring installed cards back in line. Pass `clientType` to process only the clients of one type. Processing is asynchronous: the response only gives the number of clients to sync (`clientsToSync`).\n\n:::info[Good to know]\n\n- Clients are processed in batches of 100, each batch as a bulk update operation; the response returns no operation ID to track. Each client is handled like a `PATCH /clients/{id}` with unchanged data: the `client.updated` webhook fires and an update push notification may be sent, depending on your communication rules.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7fe8e7b6-950b-40be-8206-9ff798b834d2", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientsToSync\": 150\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd534bb3-5f2a-4271-8cdb-0995e06020ff", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "417d0d0f-4faa-4c17-984b-fa17a46982b0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae499127-9e20-48ae-8757-d33f405b0f32", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a769574e-35e7-4693-8d6e-2dedf5bd7bed", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "777865df-b053-490a-8ffe-280d0fc82dc5", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9b908e0-2737-4b78-9a7b-323876b22de8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "sync-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"clientType\": \"507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/sync-all\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ab55e27-c648-4efa-a775-2f21da994cc2", "name": "Get a client by barcode", "request": { "name": "Get a client by barcode", "description": { "content": "Returns a client of the wallet from their loyalty card barcode, with the state of their card. Handy at the point of sale, after scanning the card.", "type": "text/plain" }, "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "dc1f2bd6-0a4e-4337-8084-350353b6bf4a", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c75520b-78e4-4a9b-a989-3dbf8c2efd3e", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10d6a98f-710e-4708-87ba-a159565884d3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce89b89a-1dd5-4fc9-b7f9-568141ec8a19", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8e168c2-85d1-4b24-b537-5b1833b2a116", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0591e11-84ef-4c37-a96d-c2b558ead0a4", "name": "Delete a client by barcode", "request": { "name": "Delete a client by barcode", "description": { "content": "Deletes a client identified by their loyalty card barcode, together with their card. Returns the deleted client's data.\n\n:::info[Good to know]\n\n- Permanent: the client and their loyalty card are deleted and cannot be restored. Fires the `client.deleted` webhook. To delete several clients, use `DELETE /clients/bulk`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "c69026c3-06f5-4a08-9936-f09e3a6f1708", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5910d1c1-807a-4df9-90f1-02433ac32479", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a13e06a2-e7e8-4d7e-a9ad-cc585c0b1b53", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "660d2395-8457-4714-b09a-1f5ee6ae3cef", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8552e598-658f-4245-bd65-0763283b72c0", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ede8e10-3b42-4717-a513-aa87f36358fc", "name": "Update a client by barcode", "request": { "name": "Update a client by barcode", "description": { "content": "Updates a client identified by their loyalty card barcode. Same behavior as `PATCH /clients/{id}`: only the fields you send change and the card is updated. Returns the updated client.\n\n:::info[Good to know]\n\n- An email or barcode already used by another client of the wallet returns `409` (`EMAIL_ALREADY_EXISTS`, `BARCODE_ALREADY_EXISTS`). A change of `gain` is handled as an `EARNINGS_UPDATE`, any other change as an `UPDATE_LOYALTY`: the card is only synced if at least one channel is enabled for that notification type, and the push is only sent if the notification template enables it and the client has not opted out. Fires the `client.updated` webhook.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "28fa1fd9-698a-4c99-8340-870af77b0896", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7dc219-3ba2-4140-a71c-e1bb76755058", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4664dc26-0e25-4b48-a7a7-a4987066a1ab", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3893a8c-7fc9-474f-a973-d986dff40a9a", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8e14958-a3d8-4859-a466-5017e190d80f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e046cf-8ac2-4e92-ae07-13213006d3d1", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "868c44b4-04c9-44fe-b92d-907db1fafaee", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Current barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b32b6cf0-0899-4b96-b388-75ce6a5aee80", "name": "Update client-specific pass fields", "request": { "name": "Update client-specific pass fields", "description": { "content": "Fields: `overrideStrip`, `additionalInformations`, `barcode`, `altBarcode`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "overrideStrip", "type": "file", "description": "Optional strip image override" }, { "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text", "description": "" }, { "key": "barcode", "value": "string", "type": "text", "description": "" }, { "key": "altBarcode", "value": "string", "type": "text", "description": "Overrides altText in PassBuilder when provided" } ] } }, "response": [ { "id": "4ea89f8a-b873-44c5-828c-8065179ff00d", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f2c0c45-6a49-4227-bb03-742b2993b990", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "257d541d-606f-4b0e-b87c-85478539d3e1", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82ec2ec4-ff88-4612-a5c6-8ebed0e19173", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3ac641b-ae51-443b-9f5f-10bb180cd643", "name": "`PASS_BUILDER_PASS_ID_NOT_FOUND` · `PASSBUILDER_UPDATE_FAILED` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Pass builder pass ID not found\",\n \"errorCode\": \"404:PASS_BUILDER_PASS_ID_NOT_FOUND\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24950cc-185e-45ce-a03b-52f52d323aad", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b48ee53-144b-4eb8-a5ad-f8bbf5e51077", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15d6bae6-6f82-4ca8-a87d-ac8f131bfa1d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdd3267c-ef6a-4693-b733-efe09944835c", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id", "specific" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image override", "type": "text/plain" }, "key": "overrideStrip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "additionalInformations", "value": "[{\"title\":\"PhoneNumber\",\"value\":\"+33142084254\",\"kind\":\"PHONE\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "barcode", "value": "string", "type": "text" }, { "description": { "content": "Overrides altText in PassBuilder when provided", "type": "text/plain" }, "key": "altBarcode", "value": "string", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/clients/:id/specific\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28f696f5-1692-4605-bac7-b05fc25ac027", "name": "Update a client", "request": { "name": "Update a client", "description": { "content": "Updates a client and their loyalty card. Only the fields you send change; the card installed on the client's phone is updated accordingly. Returns the updated client.\n\n:::info[Good to know]\n\n- An email or barcode already used by another client of the wallet returns `409` (`EMAIL_ALREADY_EXISTS`, `BARCODE_ALREADY_EXISTS`). A change of `gain` is handled as an `EARNINGS_UPDATE`, any other change as an `UPDATE_LOYALTY`: the card is only synced if at least one channel is enabled for that notification type, and the push is only sent if the notification template enables it and the client has not opted out. Fires the `client.updated` webhook.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b8b1bda-38ae-427a-ac40-a40d36649df2", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17f448ad-aa9e-4265-adf3-a515cc3bfee6", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b070bf4e-cb45-4ab5-a856-8823f6a0fac4", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a0566e4-01d3-41c2-b17e-25c31a502bc7", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d253b32-f5ac-4168-a661-4b2cb495bcd3", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c92b5e50-10ea-42a6-b31b-4ffe53c5757c", "name": "`EMAIL_ALREADY_EXISTS` · `BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Email already exists\",\n \"errorCode\": \"409:EMAIL_ALREADY_EXISTS\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e97ec8f5-6024-46cb-ba78-c811653a1f15", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c1643d-0a12-4a7a-831d-ed2c47d66535", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Mc5@S.pls\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"renewalDate\": \"1984-06-03T11:22:51.773Z\",\n \"birthDate\": \"2010-08-22T02:09:06.898Z\",\n \"admissionDate\": \"1995-06-19T21:05:38.119Z\",\n \"clientType\": \"string\",\n \"gain\": 9462.132350986592,\n \"companyName\": \"string\",\n \"source\": \"CRM\",\n \"sendCard\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7e68618-d7e6-40d8-908b-04a69f8cb97e", "name": "Get a client", "request": { "name": "Get a client", "description": { "content": "Returns a client by ID, with the state of their loyalty card (`passStatus`, `deviceTypes`, `shortLink`), their type name (`clientTypeName`) and the status of their other passes.", "type": "text/plain" }, "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "19aba50f-ef6f-4b4c-880e-6bf1c0a1056e", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8939ddc-3c02-4c40-a468-0d91522ab223", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84fef9d-c9ed-4afd-8156-111e5ea57a02", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "036f8d08-ebb9-443c-b304-29ed824a0273", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f5f0b1-9110-44c0-b1b4-5c4fda856ed9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "932dbdc7-184e-47e4-be13-55645fa738aa", "name": "Delete a client", "request": { "name": "Delete a client", "description": { "content": "Deletes a client and their loyalty card. Returns the deleted client's data.\n\n:::info[Good to know]\n\n- Permanent: the client and their loyalty card are deleted and cannot be restored. Fires the `client.deleted` webhook. To delete several clients, use `DELETE /clients/bulk`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "506d6e9f-e9ff-4651-8b1e-57d573e8a880", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76fcc4b1-3b79-481b-b8e9-82669759fc22", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "652fae4f-e116-489f-bee4-7dd6a53cd87c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14654a22-929a-45a6-a5a7-e1d2f4891615", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "015edc58-814d-4e11-a149-3b60fef930f4", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "660752a8-ad8e-4dfe-86c1-e1a1653f7f7f", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/clients/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1faabac-a8a4-4b1c-a4af-e9e9dd9d2f37", "name": "Get client statistics", "request": { "name": "Get client statistics", "description": { "content": "Returns client statistics for the wallet: breakdown by source (`crmSource`, `internalSource`, `extrnalSource`), active and inactive cards, and active or deleted cards per platform (iOS, Android). Narrow the period with `startDate` and `endDate` (creation date).", "type": "text/plain" }, "url": { "path": [ "clients", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "1990-11-17T07:48:38.378Z", "description": "Start date for client createdAt filter" }, { "disabled": false, "key": "endDate", "value": "1990-11-17T07:48:38.378Z", "description": "End date for client createdAt filter" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "0ca6ee1e-8b56-46a0-beb0-8f7c318d9088", "originalRequest": { "url": { "path": [ "clients", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6696fe38-2437-4790-915e-b979d82fcb9e", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98e0cf01-fc10-4430-9a44-2fc3f76e0e5d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf7b651-f9ee-4171-a184-81558d1f535f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea5de966-d660-46d6-9856-effb3dfbefa3", "name": "Send a reminder for inactive passes", "request": { "name": "Send a reminder for inactive passes", "description": { "content": "Sends an email and/or SMS reminder to clients whose loyalty card has the `inactive` status. `type: all` targets all of them, `type: specific` only the clients listed in `ids`. Returns the number of cards found (`totalPasses`), reminders queued (`emailsQueued`) and cards skipped (`passesSkipped`).\n\n:::info[Good to know]\n\n- `ids[]` is required when `type` is `SPECIFIC`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e15761c-999f-429a-872a-4c56b5f4aed7", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"totalPasses\": 100,\n \"emailsQueued\": 85,\n \"passesSkipped\": 15\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7179eacc-65c2-4f1c-b0a9-6ddb440085e2", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INSUFFICIENT_CREDIT` · `OPERATION_TYPE_REQUIRED` · `OPERATION_TYPE_NOT_ALLOWED`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb540166-0008-45dc-9c72-0caa55ab4333", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3a1e199-069b-4dc7-8fff-6eceb19f15da", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2d335e8-7b5b-4001-9eed-70251520f5f7", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40691101-3166-47be-a6d1-97ea1f02d268", "name": "`INSUFFICIENT_CREDIT_PARTIAL`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Some channels do not have enough credit to notify every client. Confirm to send only on the channels that do.\",\n \"errorCode\": \"409:INSUFFICIENT_CREDIT_PARTIAL\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcab1e8b-a366-4fe1-8831-c5abb127cd9c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "reminder-inactive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"all\",\n \"ids\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/reminder-inactive\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "300a365e-0dfd-458d-b2bc-5bbeefe13984", "name": "Update a client's points balance (gain)", "request": { "name": "Update a client's points balance (gain)", "description": { "content": "Replaces a client's points balance (`gain`) and updates their loyalty card. Returns the updated client.\n\n:::info[Good to know]\n\n- `gain` is the new balance, not an increment. Sending the current balance returns `204` (`NOTHING_TO_UPDATE`). Each change is added to `gainHistory`; the `EARNINGS_UPDATE` push is sent if the notification template enables it and the client has not opted out. Fires the `client.updated` webhook.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1415a5f2-197a-4c72-8383-1f4382c7edb9", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "006b431e-8c69-4e9a-a5aa-96cac48648f3", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33ad8eea-96df-49c5-aaea-8c10d25813c5", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25c5250f-7f0c-4b02-bcbd-2b3edf0a006c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06399020-7262-4b70-8ad2-9340778737f6", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4661ebc7-14ba-449b-a471-ac3c9b9a7f70", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43596fad-2969-4475-9f19-2f7bec55dbc8", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":id", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/clients/:id/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3ee8b4a-ee2c-4068-91de-19cb593d4630", "name": "Update a client's points balance (gain) by barcode", "request": { "name": "Update a client's points balance (gain) by barcode", "description": { "content": "Replaces the points balance (`gain`) of a client identified by their loyalty card barcode. Same behavior as `PATCH /clients/{id}/gain`. Returns the updated client.\n\n:::info[Good to know]\n\n- `gain` is the new balance, not an increment. Sending the current balance returns `204` (`NOTHING_TO_UPDATE`). Each change is added to `gainHistory`; the `EARNINGS_UPDATE` push is sent if the notification template enables it and the client has not opted out. Fires the `client.updated` webhook.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b54f1014-b183-4e48-82b5-327bafe23436", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2024-06-24T03:50:04.200Z\",\n \"updatedAt\": \"2002-05-27T09:24:39.174Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"storeCard\": {\n \"value\": \"\"\n },\n \"name\": \"string\",\n \"isDefault\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1961-04-03T15:15:07.618Z\",\n \"updatedAt\": \"2003-02-23T17:29:21.191Z\"\n },\n \"passStatus\": \"active\",\n \"deviceTypes\": \"IOS, ANDROID\",\n \"shortLink\": \"string\",\n \"shortId\": \"string\",\n \"passBuilderPassId\": \"string\",\n \"passId\": \"string\",\n \"clientTypeName\": \"string\",\n \"otherPassStatuses\": {\n \"event\": \"deleted\",\n \"transit\": \"active\",\n \"hotel\": \"expired\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1950-01-17T08:43:49.663Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1987-12-18T11:12:31.030Z\",\n \"admissionDate\": \"2012-09-01T08:18:43.801Z\",\n \"gain\": 8967.818844442796,\n \"gainHistory\": [\n {\n \"gain\": 188.1454809489247,\n \"date\": \"1974-11-12T14:40:03.136Z\"\n },\n {\n \"gain\": 498.4453982095194,\n \"date\": \"1988-09-25T06:08:44.097Z\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"EXPIRED_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efe78a4c-ca48-4b73-b01e-d08016f1e337", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/barcode/:barcode/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c26e289-0849-4ccb-86cd-ec400301fc33", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/barcode/:barcode/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ef24570-7290-4167-86b3-30c81213e46f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/barcode/:barcode/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8417d422-45f7-4d30-ac91-216783c9dc8e", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/barcode/:barcode/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "027c0b94-18f1-45e2-8b54-3feccd814293", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", "barcode", ":barcode", "gain" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode of the client's loyalty card (exact value)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"gain\": 8512.969355539062\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/barcode/:barcode/gain\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "351231d7-1d30-4884-9b0e-574182f3f7ee", "name": "Client Types", "description": { "content": "Client segments (e.g. VIP, standard), each with its own card design.", "type": "text/plain" }, "item": [ { "id": "59673041-2bc7-45ce-83ca-80495135dc63", "name": "Create a client type", "request": { "name": "Create a client type", "description": { "content": "Creates a client type (for example VIP or standard) on the wallet's store card. The type name is shown on the cards of the clients assigned to it. Returns the created type.\n\n:::info[Good to know]\n\n- The first client type created automatically becomes the default type. With `isDefault: true`, the new type replaces the current default type. Without `name`, the type is called `Silver`; a name must be 2 to 30 characters long.\n\n:::", "type": "text/plain" }, "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bfd1f1e6-56cd-4e84-af7f-dc6fd88d590d", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"CAGNOTE\",\n \"gainUnit\": \"EURO\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1998-12-22T07:10:56.573Z\",\n \"updatedAt\": \"1947-02-16T05:42:31.996Z\",\n \"displayWalletName\": true,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"MEMBER\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"name\": \"string\",\n \"isDefault\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2023-10-15T20:43:24.866Z\",\n \"updatedAt\": \"1994-08-29T23:21:14.691Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da97f15-440f-4a66-93ad-718ff97ab048", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22a9ff11-a87a-428e-890f-203b8c59b182", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a54616-56c1-4913-843b-85396003dca7", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "753b1bf5-fbe4-4310-bf2c-7b0d445d51d3", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a31c8d-48a3-40ce-b434-927ee75259b0", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28450fa6-7b36-43f2-9c0f-bf5527243747", "name": "List client types", "request": { "name": "List client types", "description": { "content": "Paginated list of the client types (segments) attached to the wallet's store card. Each type shows whether it is the default type (`isDefault`), which is assigned to clients created without a `clientType`.", "type": "text/plain" }, "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial match on the client type ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field, for example `createdAt` or `name`. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Items per page, from `1` to `1000`. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at `1`. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "cc23e2d4-8726-40eb-bf68-6737912fa7ea", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3278bdc-edc5-4457-aa8f-ae81192ced65", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b1da50-2a62-4662-808d-893452ee35bb", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e77cb6b7-aaaa-4b87-9840-3b7371c96f2a", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd219ade-e68a-4851-9497-283b78514376", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "client-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/client-types\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a66b711b-1912-4d1e-9bd6-7296d8de5451", "name": "Get a client type", "request": { "name": "Get a client type", "description": { "content": "Returns a client type by ID: its name, whether it is the default type (`isDefault`) and the store card it belongs to.", "type": "text/plain" }, "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "ec79a27b-c2f6-402c-b75e-c97305a31bc1", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"CAGNOTE\",\n \"gainUnit\": \"EURO\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1998-12-22T07:10:56.573Z\",\n \"updatedAt\": \"1947-02-16T05:42:31.996Z\",\n \"displayWalletName\": true,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"MEMBER\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"name\": \"string\",\n \"isDefault\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2023-10-15T20:43:24.866Z\",\n \"updatedAt\": \"1994-08-29T23:21:14.691Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e6554d-eb00-4728-a5eb-309fd380c2e1", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97b95961-043a-4e15-9b08-33f277caf726", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e3e0402-8371-4730-bcc5-7c330cb19b08", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf61205e-b377-4465-95eb-8354a1d0ea74", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12c69560-f820-482f-87d7-57ea00ba5eea", "name": "Update a client type", "request": { "name": "Update a client type", "description": { "content": "Renames a client type or changes the wallet's default type. Returns the updated type.\n\n:::info[Good to know]\n\n- Always send both `name` and `isDefault`: an omitted field is reset to its default value (`Silver` for `name`, `false` for `isDefault`). A name change is applied in the background to the cards of the clients of this type. Removing the default status moves it to the oldest other type; if there is none, the request returns `400` (`DEFAULT_CLIENT_TYPE_REQUIRED`).\n\n:::", "type": "text/plain" }, "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "62515c22-755b-435a-8f52-6b73922d5c84", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"CAGNOTE\",\n \"gainUnit\": \"EURO\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1998-12-22T07:10:56.573Z\",\n \"updatedAt\": \"1947-02-16T05:42:31.996Z\",\n \"displayWalletName\": true,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"MEMBER\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"name\": \"string\",\n \"isDefault\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2023-10-15T20:43:24.866Z\",\n \"updatedAt\": \"1994-08-29T23:21:14.691Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6abf39e-f444-43e2-a2c5-7006f2f5c3fa", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `DEFAULT_CLIENT_TYPE_REQUIRED`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fefb503-b962-4d3a-8d98-8d9d47fe21df", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64745425-3de2-4d82-a2cc-35b69ccb31fa", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23cc0444-5910-4dc5-956c-bcf4afeccf80", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89dc9bda-e7c1-4152-b56a-db82da7bb200", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Silver\",\n \"isDefault\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d8fb149-7dfc-42a7-a123-cbcb57cf296c", "name": "Delete a client type", "request": { "name": "Delete a client type", "description": { "content": "Deletes a client type and returns the deleted type.\n\n:::info[Good to know]\n\n- The last remaining client type cannot be deleted if it is the default type: `400` (`DEFAULT_CLIENT_TYPE_REQUIRED`). To delete the default type, first make another type the default with `PATCH /client-types/{id}`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "4c513999-72ae-4f64-8d11-6bb60bd9cb13", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"CAGNOTE\",\n \"gainUnit\": \"EURO\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1998-12-22T07:10:56.573Z\",\n \"updatedAt\": \"1947-02-16T05:42:31.996Z\",\n \"displayWalletName\": true,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"MEMBER\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"name\": \"string\",\n \"isDefault\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2023-10-15T20:43:24.866Z\",\n \"updatedAt\": \"1994-08-29T23:21:14.691Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07ccacea-3ae5-484f-99f4-e7e317dbe646", "name": "`DEFAULT_CLIENT_TYPE_REQUIRED`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"At least one client type must remain default\",\n \"errorCode\": \"400:DEFAULT_CLIENT_TYPE_REQUIRED\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95e954e5-24c9-49ae-9509-7923a526e4fe", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a45357c3-1531-49f2-8fcd-9d22cb756a4f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9dd336e-e337-4e90-b883-da1dfcd547a5", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e69e1867-0af9-44aa-b771-621c8d3e0441", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "client-types", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Client type ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/client-types/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b0cdeb21-5d32-4520-a776-646895f2380b", "name": "CSV Operations", "description": { "content": "Background client import and export.", "type": "text/plain" }, "item": [ { "id": "9d5670ff-61d1-4112-942a-0df92d7090db", "name": "Import clients from a CSV file", "request": { "name": "Import clients from a CSV file", "description": { "content": "Runs in the background: the response is a CSV operation whose progress you can follow with `GET /csv-operations`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) " }, { "key": "sendNotificationsToCustomers", "value": "true", "type": "text", "description": "" } ] } }, "response": [ { "id": "0e33ab40-d1d1-4ac8-a009-6e01a46bc454", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"ALL\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1976-08-18T05:01:52.384Z\",\n \"updatedAt\": \"1949-08-25T23:05:30.302Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"operationType\": \"IMPORT\",\n \"startTime\": \"1972-07-16T01:00:14.468Z\",\n \"numDuplicates\": 3314.729607736431,\n \"numInvalid\": 400.58715309206906,\n \"numValid\": 490.37965491183667,\n \"numSuccessful\": 10.733340889779175,\n \"sendNotificationsToCustomers\": true,\n \"status\": \"PENDING\",\n \"_id\": \"string\",\n \"createdAt\": \"1992-10-10T11:43:04.762Z\",\n \"updatedAt\": \"2011-06-17T23:39:00.646Z\",\n \"endTime\": \"1958-03-25T02:31:29.509Z\",\n \"numRecords\": 9928.65654137883,\n \"fileName\": \"string\",\n \"fileLink\": \"string\",\n \"invalidCsvFileLink\": \"string\",\n \"customerCsvFileLink\": \"string\",\n \"validCustomersCsv\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "508d9fa7-8b9d-4b13-bba0-25c4ee96cb07", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `SYSTEM_DOES_NOT_SUPPORT_MORE_THAN_100000_CUSTOMERS`", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/csv-operations/import-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fa922b5-e4e9-4b74-bb88-d33a204eb9da", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/csv-operations/import-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02e68511-4d80-4063-adb5-25d1a11e3d9f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/csv-operations/import-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3218233-8628-4ffa-9ec2-ce6bff85a29d", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/csv-operations/import-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85a222a7-a7d1-42e8-8749-6806795d9a9d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "csv-operations", "import-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "sendNotificationsToCustomers", "value": "true", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/csv-operations/import-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11749f60-be67-4aaf-85c7-6de0877961ca", "name": "Export clients to CSV", "request": { "name": "Export clients to CSV", "description": { "content": "Runs in the background: the response is a CSV operation whose progress you can follow with `GET /csv-operations`.\n\n:::info[Good to know]\n\n- Exports every client of the wallet. When the operation reaches `SUCCESS`, `fileLink` holds the URL of the CSV file (UTF-8 with BOM) and the user who requested the export receives an email with the link; on error the status becomes `FAILURE`. Columns: `_id`, `firstName`, `lastName`, `email`, `renewalDate`, `source`, `phoneNumber`, `wallet`, `barcode`, `admissionDate`, `createdAt`, `birthDate`, `status`, `devices`, `type`, `shortlink`, `gain`, `communicationPreferences`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "csv-operations", "export-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "2313fadd-72e4-4b42-b49a-75e4adee9b0a", "originalRequest": { "url": { "path": [ "csv-operations", "export-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"ALL\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1976-08-18T05:01:52.384Z\",\n \"updatedAt\": \"1949-08-25T23:05:30.302Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"operationType\": \"IMPORT\",\n \"startTime\": \"1972-07-16T01:00:14.468Z\",\n \"numDuplicates\": 3314.729607736431,\n \"numInvalid\": 400.58715309206906,\n \"numValid\": 490.37965491183667,\n \"numSuccessful\": 10.733340889779175,\n \"sendNotificationsToCustomers\": true,\n \"status\": \"PENDING\",\n \"_id\": \"string\",\n \"createdAt\": \"1992-10-10T11:43:04.762Z\",\n \"updatedAt\": \"2011-06-17T23:39:00.646Z\",\n \"endTime\": \"1958-03-25T02:31:29.509Z\",\n \"numRecords\": 9928.65654137883,\n \"fileName\": \"string\",\n \"fileLink\": \"string\",\n \"invalidCsvFileLink\": \"string\",\n \"customerCsvFileLink\": \"string\",\n \"validCustomersCsv\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "006c914b-f0bc-451e-a8ff-10bd09a1e4b5", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "csv-operations", "export-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/csv-operations/export-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6caad70d-4c0b-49eb-9638-e35479e08049", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "csv-operations", "export-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/csv-operations/export-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5b460cd-3678-4654-bfc9-05d9a1f7a1b9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "csv-operations", "export-csv" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/csv-operations/export-csv\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "defcd15c-f500-4d11-beed-76a67117c053", "name": "List CSV operations", "request": { "name": "List CSV operations", "description": { "content": "Lists the wallet's CSV import and export operations, most recent first by default. Use it to follow a background import or export and to get the generated file (`fileLink`). Filter by `operationType` (`IMPORT` or `EXPORT`).\n\n:::info[Good to know]\n\n- An operation starts as `PENDING`, then ends as `SUCCESS` or `FAILURE`. For an export, `fileLink` is the URL of the generated CSV. For an import, `numValid`, `numInvalid`, `numDuplicates` and `numSuccessful` summarize the processing, and `invalidCsvFileLink` points to a CSV of the invalid rows with their errors.\n\n:::", "type": "text/plain" }, "url": { "path": [ "csv-operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "operationType", "value": "EXPORT", "description": "Filter by operation type" }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive partial match on the file name (`fileName`) or the operation ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field, for example `createdAt`, `startTime` or `endTime`. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Items per page, from `1` to `1000`. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at `1`. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "47ff3a86-4d23-41af-8281-5c9a4705bf30", "originalRequest": { "url": { "path": [ "csv-operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "operationType", "value": "EXPORT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea5fa8f2-d389-43c5-b354-e418fb1dd737", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "csv-operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "operationType", "value": "EXPORT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/csv-operations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "445eb199-991b-46d8-a76c-b5f39e092f7e", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "csv-operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "operationType", "value": "EXPORT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/csv-operations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f3136c6-3969-4b24-8cdf-4470810cdcd6", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "csv-operations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "operationType", "value": "EXPORT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/csv-operations\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0bb52497-ec5b-471e-b1e9-01f078fac5ba", "name": "Communication Preferences", "description": { "content": "A client's communication preferences (email, SMS, push).", "type": "text/plain" }, "item": [ { "id": "72a1b0b1-b337-4d53-9286-d5a73a344a99", "name": "Get the communication preferences of a client", "request": { "name": "Get the communication preferences of a client", "description": { "content": "Returns a client's communication preferences: allowed channels (`email`, `sms`, `notification`) per notification type, consent to informative and commercial push notifications, and the link to the public page where the client manages their own preferences (`consentLink`).\n\n:::info[Good to know]\n\n- A notification type or channel that was never set counts as allowed (`true`), as do `pushInformativeEnabled` and `pushCommercialEnabled`. `consentLink` is absent when the client has no loyalty card.\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "8176c98b-7a8f-40d6-aca3-24166effe3fd", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_COUPON\",\n \"sms\": true,\n \"email\": true,\n \"notification\": true\n },\n {\n \"notificationType\": \"NEW_COMMUNICATION\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": true,\n \"pushCommercialEnabled\": true,\n \"consentLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98f407b-1f5f-42fe-8b5a-61f08e03e7e2", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "640af7c9-e0a4-4e84-8f71-dd22abf3d97e", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186a8c62-8290-4ce8-87d2-35291a9b98da", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844d8673-bfc0-404b-a378-850018aa0b8f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f01c5027-6aae-41a3-a3cb-765e23e1502c", "name": "Update the communication preferences of a client", "request": { "name": "Update the communication preferences of a client", "description": { "content": "Updates a client's communication preferences on behalf of a manager. Only the notification types and channels you send change. Returns the updated preferences.\n\n:::info[Good to know]\n\n- Partial update despite `PUT`: only the notification types listed in `communicationPreferences` change, and an omitted channel keeps its value. Each actual change is added to the history and posted to the wallet's webhook URLs (`client`, `changedBy`, `managerId`, `changedAt`, `changes`).\n\n:::", "type": "text/plain" }, "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_CRM_CLIENTS\",\n \"sms\": true,\n \"email\": false,\n \"notification\": true\n },\n {\n \"notificationType\": \"NEW_COUPON\",\n \"sms\": false,\n \"email\": false,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": true,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2246ce1a-e204-4af3-9241-5715a21b8e97", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"WELCOME_CRM_CLIENTS\",\n \"sms\": false,\n \"email\": false,\n \"notification\": true\n },\n {\n \"notificationType\": \"UPDATE_LOYALTY\",\n \"sms\": false,\n \"email\": true,\n \"notification\": false\n }\n ],\n \"pushInformativeEnabled\": true,\n \"pushCommercialEnabled\": false,\n \"consentLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6caa596-e62c-4f50-91ac-b29e44ea2d63", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcc97e83-a2ad-4c51-a9ed-1d732a9d91b3", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a4d8929-0817-4af9-bfbe-fb344f0b3f46", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be928f35-0c65-4816-83bf-b192a6985330", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41162a8d-e124-4023-9eb8-81001cd32963", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"communicationPreferences\": [\n {\n \"notificationType\": \"EARNINGS_UPDATE\",\n \"sms\": true,\n \"email\": true,\n \"notification\": false\n },\n {\n \"notificationType\": \"HOTEL_RESERVATION\",\n \"sms\": false,\n \"email\": true,\n \"notification\": true\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:clientId/communication-preferences\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55413d01-a815-47a7-b527-16b7eeff24ef", "name": "Get the communication preference history of a client", "request": { "name": "Get the communication preference history of a client", "description": { "content": "Returns the paginated history of a client's communication preference changes, newest first. Each entry gives the channel and event concerned, the old and new value, who made the change and when, with translated labels.", "type": "text/plain" }, "url": { "path": [ "clients", ":clientId", "communication-preferences", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "string", "description": "(Required) Page number, starting at `1`. Default: `1`." }, { "disabled": false, "key": "limit", "value": "string", "description": "(Required) Entries per page. Default: `20`." }, { "disabled": false, "key": "lang", "value": "string", "description": "(Required) Language of the labels (`channelLabel`, `eventLabel`, `oldValueLabel`, `newValueLabel`): `fr` or `en`. Default: `fr`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "9edc3849-3274-4965-8661-75980c46ecbf", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "string" }, { "key": "limit", "value": "string" }, { "key": "lang", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"client\": {},\n \"wallet\": {},\n \"changedAt\": \"2023-07-31T20:30:00.502Z\",\n \"changedBy\": \"MANAGER\",\n \"field\": \"string\",\n \"oldValue\": true,\n \"newValue\": true,\n \"managerId\": {}\n },\n {\n \"client\": {},\n \"wallet\": {},\n \"changedAt\": \"2003-08-26T02:19:11.554Z\",\n \"changedBy\": \"MANAGER\",\n \"field\": \"string\",\n \"oldValue\": false,\n \"newValue\": true,\n \"managerId\": {}\n }\n ],\n \"totalDocs\": 915.7567883799422,\n \"limit\": 4280.895200471396,\n \"totalPages\": 9507.22270429426,\n \"pagingCounter\": 6495.335641708569,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"page\": 7714.057329047563,\n \"prevPage\": 7645.34821421131,\n \"nextPage\": 5149.896589069649\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30bb968-eb52-4e0e-8ddf-a70e48c10ccf", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "string" }, { "key": "limit", "value": "string" }, { "key": "lang", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/clients/:clientId/communication-preferences/history\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d0e8e5c-cb6a-4192-a2ff-8076c7ec4e76", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "string" }, { "key": "limit", "value": "string" }, { "key": "lang", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/clients/:clientId/communication-preferences/history\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "596797c7-4e33-4a5c-8486-59c18e418908", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "clients", ":clientId", "communication-preferences", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "string" }, { "key": "limit", "value": "string" }, { "key": "lang", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Client ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/clients/:clientId/communication-preferences/history\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0eb4d6e3-240a-4453-abf2-027adde16f77", "name": "Coupons", "description": { "content": "Coupon templates and issued coupons.", "type": "text/plain" }, "item": [ { "id": "92729edc-b55d-42e8-a7f8-2b4f85b3c4e7", "name": "Create a coupon template", "request": { "name": "Create a coupon template", "description": { "content": "Creates a coupon template in your wallet along with its pass template. Send the request as `multipart/form-data` with the strip image (`strip`). Returns the created template; then use `POST /coupons/{id}/passes/send` to send coupons to your clients.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "(Required) " }, { "key": "barcodeFormat", "value": "QR_CODE", "type": "text", "description": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "name", "value": "string", "type": "text", "description": "(Required) " }, { "key": "description", "value": "string", "type": "text", "description": "(Required) " }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "(Required) " }, { "key": "promoCode", "value": "string", "type": "text", "description": "" }, { "key": "value", "value": "string", "type": "text", "description": "" }, { "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text", "description": "" }, { "key": "isMultipleInstance", "value": "true", "type": "text", "description": "" }, { "key": "isWelcomeCoupon", "value": "true", "type": "text", "description": "" }, { "key": "status", "value": "ACTIVE", "type": "text", "description": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)" }, { "key": "source", "value": "CRM", "type": "text", "description": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)" }, { "key": "valueLabel", "value": "PRESTATION", "type": "text", "description": " (This can only be one of VALUE,AMOUNT,PRESTATION)" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text", "description": "" }, { "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "95b9a470-3065-48f3-b3dd-bece0bb5bc97", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"HOTEL\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2008-04-03T03:37:31.329Z\",\n \"updatedAt\": \"1988-09-22T23:52:11.509Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"AZTEC\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": false,\n \"isWelcomeCoupon\": false,\n \"status\": \"INACTIVE\",\n \"source\": \"CRM\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"2012-08-03T22:43:25.692Z\",\n \"updatedAt\": \"2011-07-05T20:49:08.837Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1978-10-17T15:16:36.150Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": false,\n \"disableIOSPassSharing\": true,\n \"enableOneTimeUse\": false,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"INACTIVE\",\n \"valueEnum\": \"CUSTOM_TEXT\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n },\n \"passBuilderPassTemplateId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e1d4f72-d55e-4fef-93bc-e0163d0e780d", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `PROMO_CODE_ALREADY_EXISTS` · `ACTIVE_WELCOME_COUPON_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f143d881-3ffd-438c-b1e0-cbc5b2c7fa53", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0ef1aad-fade-4b00-b32b-f20238c6d531", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15202e10-1ded-465e-bef1-d8f8e3eb9dd3", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a32cf32-7382-4418-92f9-059fe6cb53e3", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fee77e4b-8937-4426-ad1f-0df5f2536743", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "2024-02-13T20:37:29.640Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "true", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "CRM", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"CUSTOM_TEXT\",\"valueEnum\":\"INACTIVE\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e202e033-cd72-40fe-85d1-af00e60557f8", "name": "List coupon templates", "request": { "name": "List coupon templates", "description": { "content": "Returns the paginated list of coupon templates in your wallet. You can filter by status, name, promo code, template type (single or multiple instance) and creation date, or run a free-text search.\n\n:::info[Good to know]\n\n- A template whose `expirationDate` has passed switches to `EXPIRED` automatically, through a scheduled task. `name` and `promoCode` are exact-match filters; use `search` for a partial match.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` (ascending) or `desc` (descending). Default: `desc`." }, { "disabled": false, "key": "status", "value": "INACTIVE", "description": "Template status: `ACTIVE`, `INACTIVE` or `EXPIRED`." }, { "disabled": false, "key": "name", "value": "string", "description": "Exact template name (strict, case-sensitive match). For a partial match, use `search`." }, { "disabled": false, "key": "promoCode", "value": "string", "description": "Exact template promo code (strict match)." }, { "disabled": false, "key": "isMultipleInstance", "value": "false", "description": "`true` to return only multiple-instance templates, `false` for single-instance templates." }, { "disabled": false, "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z", "description": "Only return templates created on or after this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "createdAtEnd", "value": "1990-11-17T07:48:38.378Z", "description": "Only return templates created on or before this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial, case-insensitive search in `name`, `description` and `promoCode`, and in the template ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of results per page, from 1 to 1000. Default: 10." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to return, starting at 1. Default: 1." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "3ca7ca6f-a9ed-4726-a96f-25151d938452", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "INACTIVE" }, { "key": "name", "value": "string" }, { "key": "promoCode", "value": "string" }, { "key": "isMultipleInstance", "value": "true" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "createdAtEnd", "value": "1990-11-17T07:48:38.378Z" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": false,\n \"status\": \"EXPIRED\",\n \"source\": \"ALL\",\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": \"VALUE\",\n \"_id\": \"string\",\n \"createdAt\": \"2019-04-19T09:57:05.224Z\",\n \"updatedAt\": \"2012-08-08T16:26:08.495Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1948-01-08T00:46:54.961Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": false,\n \"isWelcomeCoupon\": false,\n \"status\": \"ACTIVE\",\n \"source\": \"INTERNAL\",\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": \"VALUE\",\n \"_id\": \"string\",\n \"createdAt\": \"2002-06-10T21:55:56.737Z\",\n \"updatedAt\": \"1967-11-21T04:20:01.415Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1954-03-31T08:59:48.446Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\"\n }\n ],\n \"totalDocs\": 5790.890792588852,\n \"limit\": 8105.30918566323,\n \"totalPages\": 9996.584337691314,\n \"pagingCounter\": 7188.805512359646,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 3276.756288763605,\n \"prevPage\": 915.0133546370132,\n \"nextPage\": 2554.9682246698535\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7f2cfc-3d2c-4125-9c81-608947631e1a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "INACTIVE" }, { "key": "name", "value": "string" }, { "key": "promoCode", "value": "string" }, { "key": "isMultipleInstance", "value": "true" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "createdAtEnd", "value": "1990-11-17T07:48:38.378Z" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9c3ce06-6978-4f49-a3f3-7f3ad74ddab2", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "INACTIVE" }, { "key": "name", "value": "string" }, { "key": "promoCode", "value": "string" }, { "key": "isMultipleInstance", "value": "true" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "createdAtEnd", "value": "1990-11-17T07:48:38.378Z" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d6720c5-93c9-4e20-8340-127e1a700632", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "INACTIVE" }, { "key": "name", "value": "string" }, { "key": "promoCode", "value": "string" }, { "key": "isMultipleInstance", "value": "true" }, { "key": "createdAtStart", "value": "1990-11-17T07:48:38.378Z" }, { "key": "createdAtEnd", "value": "1990-11-17T07:48:38.378Z" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "244c65cb-cfa7-4a54-8c55-7497d8d3fc6a", "name": "Update a coupon template", "request": { "name": "Update a coupon template", "description": { "content": "Updates a coupon template and its pass template; coupons already sent are updated accordingly. Accepts `application/json` or `multipart/form-data` (to replace the `strip` image). Warning: if you do not send `expirationDate`, the template's expiration date is cleared.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "" }, { "key": "barcodeFormat", "value": "AZTEC", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "name", "value": "string", "type": "text", "description": "" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "promoCode", "value": "string", "type": "text", "description": "" }, { "key": "value", "value": "string", "type": "text", "description": "" }, { "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text", "description": "" }, { "key": "isMultipleInstance", "value": "true", "type": "text", "description": "" }, { "key": "isWelcomeCoupon", "value": "false", "type": "text", "description": "" }, { "key": "status", "value": "EXPIRED", "type": "text", "description": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)" }, { "key": "source", "value": "INTERNAL", "type": "text", "description": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)" }, { "key": "valueLabel", "value": "PRESTATION", "type": "text", "description": " (This can only be one of VALUE,AMOUNT,PRESTATION)" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text", "description": "" }, { "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "c9d96465-9088-4400-a91d-35f3f847c1c9", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7eda4b6-33cf-4a04-97ef-1a0179be941d", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `PROMO_CODE_ALREADY_EXISTS` · `ACTIVE_WELCOME_COUPON_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8de63d3a-a171-4bae-9f9e-e93c880962fd", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4e6d1a5-494f-4a9c-a03f-ea2314932119", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "953a5d72-2897-49e2-902d-450ebce90fe7", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec91a493-c4e2-4174-aaaa-fee90f30e92e", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59936b5f-dd1e-42d8-af82-dc270fc866e0", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae3c4807-907f-4850-8103-09341d78a92b", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to update." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "promoCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "value", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "expirationDate", "value": "1986-09-09T11:36:21.133Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isMultipleInstance", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "isWelcomeCoupon", "value": "false", "type": "text" }, { "description": { "content": " (This can only be one of ACTIVE,INACTIVE,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "EXPIRED", "type": "text" }, { "description": { "content": " (This can only be one of INTERNAL,EXTERNAL,CRM,ALL)", "type": "text/plain" }, "key": "source", "value": "INTERNAL", "type": "text" }, { "description": { "content": " (This can only be one of VALUE,AMOUNT,PRESTATION)", "type": "text/plain" }, "key": "valueLabel", "value": "PRESTATION", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"oneTimeToUseJwtLink\":false,\"disableIOSPassSharing\":true,\"enableOneTimeUse\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"FULLNAME\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a03cd4e8-3352-4720-8ebd-44a5667ebe2b", "name": "Delete a coupon template", "request": { "name": "Delete a coupon template", "description": { "content": "Permanently deletes a coupon template and its pass template. Returns the deleted template.\n\n:::info[Good to know]\n\n- Deletion is permanent. This call deletes the template only: it does not delete the coupons already sent one by one, unlike `DELETE /coupons/{id}/passes/{instanceId}` on a multiple-instance template.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "c1aa7772-c9b5-4bf8-aa7a-28acd459573f", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"HOTEL\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2008-04-03T03:37:31.329Z\",\n \"updatedAt\": \"1988-09-22T23:52:11.509Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"AZTEC\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": false,\n \"isWelcomeCoupon\": false,\n \"status\": \"INACTIVE\",\n \"source\": \"CRM\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"2012-08-03T22:43:25.692Z\",\n \"updatedAt\": \"2011-07-05T20:49:08.837Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1978-10-17T15:16:36.150Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": false,\n \"disableIOSPassSharing\": true,\n \"enableOneTimeUse\": false,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"INACTIVE\",\n \"valueEnum\": \"CUSTOM_TEXT\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n },\n \"passBuilderPassTemplateId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a855c61d-3b69-4448-9884-03a08f984942", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0e627d7-436e-425f-873a-f0a818f7ad30", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0405c226-cc72-442e-b059-7ac605338cee", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d1ba1ea-8820-429a-a990-d127981cefd8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a795af1-b5ee-43d3-9645-1df94e64628e", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to delete." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4094efcc-5c0d-448d-a5c1-cd1260d64cfc", "name": "Get a coupon template", "request": { "name": "Get a coupon template", "description": { "content": "Returns a coupon template by its ID. Returns `MODEL_NOT_FOUND` if the template does not exist.", "type": "text/plain" }, "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "08c8d733-1324-44d6-a722-5d700d18b0ab", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"HOTEL\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2008-04-03T03:37:31.329Z\",\n \"updatedAt\": \"1988-09-22T23:52:11.509Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"AZTEC\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": false,\n \"isWelcomeCoupon\": false,\n \"status\": \"INACTIVE\",\n \"source\": \"CRM\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"2012-08-03T22:43:25.692Z\",\n \"updatedAt\": \"2011-07-05T20:49:08.837Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1978-10-17T15:16:36.150Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": false,\n \"disableIOSPassSharing\": true,\n \"enableOneTimeUse\": false,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"INACTIVE\",\n \"valueEnum\": \"CUSTOM_TEXT\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n },\n \"passBuilderPassTemplateId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ee35ebc-81aa-4750-a62e-740667e38a1f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5611bc73-bdcc-4c42-9e44-d3b32adac34f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98165db0-e7b1-4ad1-aa56-a34f7d06d99b", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38af5729-7701-4670-b1e1-28594c4bb3b9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2271be75-22ae-40a9-80fb-e949feac1d6d", "name": "List the coupons of a template", "request": { "name": "List the coupons of a template", "description": { "content": "Returns the paginated list of coupons sent from a template. By default, only coupons with status `active` or `expired` are returned, newest first.\n\n:::info[Good to know]\n\n- Without `status`, only `active` and `expired` coupons are returned. Deleted coupons are erased permanently and never appear in this list.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` (ascending) or `desc` (descending). Default: `desc`." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Only return coupons created on or after this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial, case-insensitive search in `firstName`, `lastName`, `email` and `barcode`, and in the coupon ID and client ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of results per page, from 1 to 1000. Default: 10." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to return, starting at 1. Default: 1." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "fc2cd454-573b-4af8-9022-5942644788f9", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"coupon\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 5259.603534239949,\n \"activeAndroidDeviceCount\": 412.4312024162702,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2022-11-05T21:36:55.057Z\",\n \"updatedAt\": \"2006-01-20T13:21:56.415Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1994-01-02T07:07:36.872Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1976-12-20T11:03:14.413Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2017-03-28T19:30:45.099Z\",\n \"checkout\": \"1975-01-03T20:43:58.422Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1964-04-27T02:04:42.233Z\",\n \"originalExpirationDate\": \"1972-06-24T16:05:47.020Z\",\n \"admissionDate\": \"1989-03-23T02:41:56.561Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 3915.305914564664,\n \"activeAndroidDeviceCount\": 2320.9711025644774,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1988-10-05T00:33:56.898Z\",\n \"updatedAt\": \"1989-12-18T04:08:17.633Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1951-03-18T05:34:49.811Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1973-02-24T16:11:20.771Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2002-11-26T08:01:20.968Z\",\n \"checkout\": \"1951-06-28T09:51:12.270Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1956-12-10T16:42:41.905Z\",\n \"originalExpirationDate\": \"2021-10-10T15:15:42.145Z\",\n \"admissionDate\": \"1958-11-20T16:45:16.573Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n ],\n \"totalDocs\": 7094.688490914853,\n \"limit\": 9803.637664981445,\n \"totalPages\": 7342.415573570176,\n \"pagingCounter\": 302.93203536782,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 7181.0562155666275,\n \"prevPage\": 3881.3622460758834,\n \"nextPage\": 423.2881817674583\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda9da95-e1cf-49df-9f2f-8a5503f17b15", "name": "`INVALID_PASS_KIND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invalid pass kind\",\n \"errorCode\": \"400:INVALID_PASS_KIND\",\n \"path\": \"/coupons/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a73c61ae-d42e-4b3a-a7ca-94c47da08e12", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "125431d9-e1b8-434c-929f-27df78542a2c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386c74b4-feae-41c3-af4c-61db15498bb9", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7a76cc7-6798-4c70-b6e4-be9cc21b7d18", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "763e4801-072a-4689-a50d-678772bbf634", "name": "Send coupons", "request": { "name": "Send coupons", "description": { "content": "Sends a coupon to existing clients or to recipients who are not clients. With `clientId`, the client's store card data is used; without `clientId`, `firstName`, `lastName` and `email` are required. Accepts `multipart/form-data` to override the strip image. `webhookUrl` and `forceSync` are optional. Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `clients[].firstName` is required when `clientId` is missing or `false`.\n- `clients[].lastName` is required when `clientId` is missing or `false`.\n- `clients[].email` is required when `clientId` is missing or `false`.\n- Send a coupon to existing clients ({clientId}) or to non-clients ({firstName,lastName,email}); per-recipient overrides: barcode, promoCode, description, value, expirationDate. An empty clients array means all wallet clients. Runs as a bulk operation (webhookUrl, forceSync). acceptPartialDelivery covers the case of insufficient credit on some channels (409:INSUFFICIENT_CREDIT_PARTIAL). Accepts application/json or multipart (when overrideStripImage is a file; it may also be a URL string).\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"F503br9uZVLy@iwOBlPuuZmGsJIVHDWnNaSHQ.dwv\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"2014-03-20T15:01:20.019Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"UTGF@Z.omp\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1992-06-27T00:12:56.081Z\"}]", "type": "text", "description": "(Required) " }, { "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text", "description": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token" }, { "key": "forceSync", "value": "false", "type": "text", "description": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected." }, { "key": "overrideStripImage", "type": "file", "description": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL." } ] } }, "response": [ { "id": "44962ce5-c2c7-48e9-8945-7fe6d991130c", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5fe2983-972a-40ff-a5fa-b60261c8a223", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `MISSING_RECIPIENT_DETAILS_FOR_NON_CLIENT` · `NO_RECIPIENTS_PROVIDED` · `NO_CLIENTS_FOUND` · `NO_CUSTOMERS_FOUND` · `ALL_CLIENTS_ALREADY_HAVE_COUPON`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef85eeb-ac60-4f78-b56e-7336ffe9f956", "name": "`UNAUTHORIZED` · `PASSBUILDER_TOKEN_MISSING`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9532809-7399-4a93-8f11-d65c578407e2", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f494b7d4-9c99-43b3-9adc-d66eb5f46ea3", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ab8487e-597b-4923-84b2-769bc57463ff", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0004443c-0b00-4b7d-8307-b7d4e9c484af", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60b386eb-77b3-42ff-be83-681dfa538103", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template to send." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "clients", "value": "[{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"uj7DFrYh@JfVQqUKtKGQpbwLJZPOKERqarlyh.ff\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1969-03-16T00:11:30.758Z\"},{\"clientId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"email\":\"oUoh-yH@Kpk.ae\",\"phoneNumber\":\"string\",\"barcode\":\"string\",\"promoCode\":\"string\",\"description\":\"string\",\"value\":\"string\",\"expirationDate\":\"1977-03-24T08:51:16.989Z\"}]", "type": "text" }, { "description": { "content": "Webhook URL to receive notification when bulk operation completes. Auth headers: append #headers=Authorization:Bearer%20token", "type": "text/plain" }, "key": "webhookUrl", "value": "https://example.com/webhook#headers=Authorization:Bearer%20token", "type": "text" }, { "description": { "content": "Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.", "type": "text/plain" }, "key": "forceSync", "value": "false", "type": "text" }, { "description": { "content": "Optional strip image override. In form-data: upload image file (PNG/JPEG). In application/json: provide image URL.", "type": "text/plain" }, "key": "overrideStripImage", "type": "file" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/send\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6233d1c9-b866-4e82-8d77-865a32641730", "name": "Get a coupon", "request": { "name": "Get a coupon", "description": { "content": "Returns a sent coupon, identified by its template and its `instanceId`. Returns `PASS_NOT_FOUND` if no coupon of this template matches.", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f0deca09-a435-46c8-8452-4fa8c8f4f064", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c51b26f-3510-41bf-9f41-10b59084f391", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa051ebf-ff70-496e-a0d7-bb8d1a4b3498", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37817759-074b-4fa7-bafe-14e8de3b40a2", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `PASS_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8647ec42-0ce1-4889-a580-a40936bb907a", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (`instanceId`). For a single-instance template, this is the client ID; for a multiple-instance template or a non-client recipient, it is an ID generated when the coupon is sent." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "321f2631-5d3a-41bc-9268-b07d4211979f", "name": "Update a coupon", "request": { "name": "Update a coupon", "description": { "content": "Updates the values specific to a sent coupon: `promoCode`, `description`, `value`, `expirationDate` and `bannerOverrideUrl`. Only the fields you send are changed; other values stay those of the coupon or, failing that, of the template. Returns the updated coupon.\n\n:::info[Good to know]\n\n- The holder receives the `UPDATE_COUPON` email or SMS according to your communication rules and the client's preferences; no push notification is sent. This notification is not charged.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0379598e-315d-4a6a-9566-5b17878211ce", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcdcfc0e-a43d-4aa3-ab6e-47a7f36bc17f", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60bf131d-36b5-4114-baa7-45c079eca178", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb01e161-7a05-4cd4-913e-3f062996b66b", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c8e1899-3fbb-4871-ae6b-5549d9f6f40d", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f8fa7a-66e5-4e73-b5a7-e2a5648bb8b0", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2d8cffc-15d1-4583-8f65-4aa654c6b225", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to update (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2012-11-18T11:26:31.465Z\",\n \"bannerOverrideUrl\": \"http://HDrbwqEnrwdlikpsen.onqNa76F1MRTMshcJquTBkhzbQWhy6iyiAy1.LmifxTfpMsbvRbTnmbdt\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19295092-431a-44f7-8e97-e550bc2198b7", "name": "Delete a coupon", "request": { "name": "Delete a coupon", "description": { "content": "Permanently deletes a sent coupon. On a multiple-instance template, this call deletes the whole template and all its coupons (see below).\n\n:::info[Good to know]\n\n- On a multiple-instance template (`isMultipleInstance: true`), this call deletes the whole template: every coupon sent from it and the template itself; the response is then the deleted template. On a single-instance template, only the targeted coupon is deleted and returned. Deletion is permanent.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "8131621c-223f-4831-a8fa-ff83398a456c", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b9c7578-1ec2-4377-987e-eb42e0acad19", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f07b5733-9adc-4e97-a588-c7703ff53744", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c4bfa7e-1e31-4c9c-b1ea-5043e11165cd", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ae8fa86-3e28-4a27-ba7b-dc8d11c2b377", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af19f313-6064-4e4a-90a6-f88d4a01cb46", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to delete (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6741daa7-2f4b-43aa-b92b-becaafedd645", "name": "Expire a coupon", "request": { "name": "Expire a coupon", "description": { "content": "Expires a sent coupon immediately: its status becomes `expired` and its expiration date is set to now. Returns the updated coupon, or `PASS_ALREADY_EXPIRED` if it has already expired.\n\n:::info[Good to know]\n\n- On a multiple-instance template, the coupon is also removed from the client's store card. The `EXPIRED_COUPON` email or SMS is sent only if your communication rules explicitly enable it for that channel, and if the client accepts it. Same behaviour as `PUT /coupons/{id}/passes/{instanceId}/status` with `EXPIRED`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "19bb2267-ab22-4644-a0c9-e208acce3f7c", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03a516a2-3599-4713-a376-0304756d074a", "name": "`PASS_ALREADY_EXPIRED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Pass already expired\",\n \"errorCode\": \"400:PASS_ALREADY_EXPIRED\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f7ee21-b2d9-4eae-95c6-bd8bf06794e8", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72c5c66b-0b7b-4165-b983-98e674b303c2", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c87eb468-11b4-4643-a4c3-7af0b3778d42", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7187ef0-ca16-43ba-90f3-7c1a4ab46fbb", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6423b54e-d99d-45e9-9ddd-656c30111185", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "expire" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Instance ID of the coupon to expire (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId/expire\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc0bfa22-573f-4762-b03c-0cd644f44d83", "name": "Update the status of a coupon", "request": { "name": "Update the status of a coupon", "description": { "content": "Allowed statuses: `EXPIRED`, `USED`, `UNUSED`.\n\n:::info[Good to know]\n\n- `EXPIRED` behaves like `POST .../expire` (`PASS_ALREADY_EXPIRED` if already expired). `USED` marks the coupon as redeemed and sends the holder a push notification (`PASS_ALREADY_REDEEMED` if already redeemed). `UNUSED` reverts the redemption (`PASS_NOT_REDEEMED` if the coupon is not marked as used).\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fe67fa08-165d-4c5d-afb7-ca7c7c7d4f29", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6889c97d-02ed-4fd3-a213-a6fca2c49955", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_STATUS` · `PASS_ALREADY_EXPIRED` · `PASS_ALREADY_REDEEMED` · `PASS_NOT_REDEEMED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e38a2c04-a939-4dbb-b77e-7bba21508fa4", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/:instanceId/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f5ede5e-84d3-4d53-8bfc-d6c0398e18cc", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/:instanceId/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c9d765-2663-4935-92e6-44065ff561be", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/:instanceId/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ce842ab-6d2b-4850-89cb-8379dc626c3e", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", ":instanceId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." }, { "disabled": false, "type": "any", "value": "string", "key": "instanceId", "description": "(Required) Coupon instance ID (the client ID for a single-instance template)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/:instanceId/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c12966e8-9a70-42af-98a3-8a3cdc5ca957", "name": "List the coupons of a client", "request": { "name": "List the coupons of a client", "description": { "content": "Searches sent coupons using the value passed in `clientId`: coupons whose barcode equals this value, or whose first name, last name or email contains it. Only coupons with status `active` or `expired` are returned.", "type": "text/plain" }, "url": { "path": [ "coupons", "clients", ":clientId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Common coupon-list parameter; this route does not use it to sort results." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Common coupon-list parameter; this route does not use it as a date filter." }, { "disabled": false, "key": "search", "value": "string", "description": "Common coupon-list parameter; this route does not use it as a free-text search." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Common coupon-list parameter; this route does not use it to sort results." }, { "disabled": false, "key": "limit", "value": "10", "description": "Echoed in the `limit` field of the response. This route returns all results in `docs`, without splitting them into pages." }, { "disabled": false, "key": "page", "value": "1", "description": "Echoed in the `page` field of the response. This route returns all results in `docs`, without splitting them into pages." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Value to search for (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "9aaa2528-11e8-420b-8a4a-b8ced6851235", "originalRequest": { "url": { "path": [ "coupons", "clients", ":clientId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Value to search for (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"coupon\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 5259.603534239949,\n \"activeAndroidDeviceCount\": 412.4312024162702,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2022-11-05T21:36:55.057Z\",\n \"updatedAt\": \"2006-01-20T13:21:56.415Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1994-01-02T07:07:36.872Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1976-12-20T11:03:14.413Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2017-03-28T19:30:45.099Z\",\n \"checkout\": \"1975-01-03T20:43:58.422Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1964-04-27T02:04:42.233Z\",\n \"originalExpirationDate\": \"1972-06-24T16:05:47.020Z\",\n \"admissionDate\": \"1989-03-23T02:41:56.561Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 3915.305914564664,\n \"activeAndroidDeviceCount\": 2320.9711025644774,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1988-10-05T00:33:56.898Z\",\n \"updatedAt\": \"1989-12-18T04:08:17.633Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1951-03-18T05:34:49.811Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1973-02-24T16:11:20.771Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2002-11-26T08:01:20.968Z\",\n \"checkout\": \"1951-06-28T09:51:12.270Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1956-12-10T16:42:41.905Z\",\n \"originalExpirationDate\": \"2021-10-10T15:15:42.145Z\",\n \"admissionDate\": \"1958-11-20T16:45:16.573Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n ],\n \"totalDocs\": 7094.688490914853,\n \"limit\": 9803.637664981445,\n \"totalPages\": 7342.415573570176,\n \"pagingCounter\": 302.93203536782,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 7181.0562155666275,\n \"prevPage\": 3881.3622460758834,\n \"nextPage\": 423.2881817674583\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "192fc33d-095f-41e5-bbf5-d162805f9767", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", "clients", ":clientId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Value to search for (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/clients/:clientId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3356817-8d1c-4521-ba51-dd63136e7aba", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", "clients", ":clientId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Value to search for (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/clients/:clientId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26462904-b918-45dc-b448-8a740dbae95f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", "clients", ":clientId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "clientId", "description": "(Required) Value to search for (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/clients/:clientId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8e621c1-9351-4abc-84fc-b51e5944cdbb", "name": "Get coupon statistics for a template", "request": { "name": "Get coupon statistics for a template", "description": { "content": "Returns two counters for a coupon template: the number of coupons sent (`countOfSentCouponPasses`) and the number of coupons added to a mobile wallet (`countOfDownloadedPasses`).\n\n:::info[Good to know]\n\n- `countOfDownloadedPasses` counts the coupons installed on at least one device. `countOfSentCouponPasses` counts every coupon of the template that still exists, whatever its status; deleted coupons are not counted.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e6ed3a0e-a82f-465c-87e7-17b523b15cbf", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"countOfDownloadedPasses\": 6,\n \"countOfSentCouponPasses\": 99\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b39a6376-fe59-4c71-ab16-dc327b8482d5", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb55f2f-f210-4426-84cf-2f32ee6b87ed", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc9a9203-aa03-41fc-a2cf-0604b10548d9", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "865b5c9b-6aaf-4cf7-8ef3-34bab58fb24d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "stats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Coupon template ID." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33ffdf7c-39fb-4f8b-95b0-330bd948ff51", "name": "Bulk update coupons", "request": { "name": "Bulk update coupons", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Up to 5000 items, each with its `instanceId` and the fields to change. Runs in the background by default; with `forceSync: true` (fewer than 1000 items, otherwise `SYNC_EXECUTION_NOT_ALLOWED`) the response already contains the results. Each coupon is updated as with `PATCH /coupons/{id}/passes/{instanceId}`, including the `UPDATE_COUPON` email or SMS.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "18d77fb2-3ca6-4174-a911-e0ff01b7efae", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a9c262-0e3e-4630-b4c1-7a93fa9d8391", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23968a20-ab12-40ff-bd79-c9c206c1602a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "891526e4-3ba9-4f70-bfaf-ab43b00edfbc", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf6ecda9-9e70-42f7-a049-80f8c694068f", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c13b16c-365b-4265-859e-0353f576df4e", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are updated." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"instanceId\": \"507f1f77bcf86cd799439011\",\n \"promoCode\": \"string\",\n \"description\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"2007-12-07T11:17:21.232Z\",\n \"bannerOverrideUrl\": \"https://JBodMUdbOCaSMPi.nrgejnLHW9GvKmjtY4cPqTL7\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c85294bd-48e0-408c-bf07-2958187c4645", "name": "Bulk delete coupons", "request": { "name": "Bulk delete coupons", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Each `instanceId` is deleted as with `DELETE /coupons/{id}/passes/{instanceId}`: on a multiple-instance template, the first deletion removes the whole template and its coupons, and the following items fail. Runs in the background by default; with `forceSync: true` (fewer than 1000 items, otherwise `SYNC_EXECUTION_NOT_ALLOWED`) the response already contains the results.\n\n:::", "type": "text/plain" }, "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20583c91-e20b-4669-bd5f-975f9ad719c0", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e7bd4e6-cce5-48a6-84df-5e530e2766e0", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f09d95e-a1ee-4ee4-8fa6-53e3fa757ecb", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e633aae-165e-4295-8458-d864865f8056", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48fe1212-d23b-47ae-88cc-3f912bc1c098", "name": "`COUPON_TEMPLATE_NOT_FOUND` · `MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Coupon template not found\",\n \"errorCode\": \"404:COUPON_TEMPLATE_NOT_FOUND\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5cf3da1-36ce-4361-9a09-78f08291aaa6", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "coupons", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ID of the coupon template whose coupons are deleted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"instanceIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/coupons/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6a6ca772-72ca-4838-97d8-5f1395b3ac40", "name": "Events", "description": { "content": "Event tickets (concerts, fairs, matches).", "type": "text/plain" }, "item": [ { "id": "f4840621-6fac-44b9-8b75-d8d5114af077", "name": "Create an event", "request": { "name": "Create an event", "description": { "content": "Creates an event, i.e. the ticket template (name, dates, locations, colours, strip image) shared by all its passes. The request is sent as `multipart/form-data` and returns the created event.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- Uses barcodeType (not barcodeFormat as in coupons/transits/hotels). Nested objects (date, locations, colors, security) are sent as JSON strings in multipart. date.startDate must be before endDate and doorOpeningHour before startDate. price is 0..9999.99. contactPhone must be E.164-like (+...).\n\n:::", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "(Required) " }, { "key": "barcodeType", "value": "AZTEC", "type": "text", "description": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "name", "value": "string", "type": "text", "description": "(Required) " }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "(Required) " }, { "key": "locations", "value": "[{\"longitude\":7444.243568573079,\"latitude\":1168.0702276346367,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":9318.849589464546,\"latitude\":7923.138114415531,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text", "description": "" }, { "key": "date", "value": "{\"startDate\":\"1956-09-18T21:32:44.991Z\",\"endDate\":\"1964-06-03T18:25:27.057Z\",\"doorOpeningHour\":\"1965-05-16T11:33:27.990Z\"}", "type": "text", "description": "" }, { "key": "price", "value": "4679.170510737617", "type": "text", "description": "" }, { "key": "gainUnit", "value": "NONE", "type": "text", "description": " (This can only be one of NONE,EURO,USD,MAD,POINTS)" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "terms", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "contactPhone", "value": "+7 9 9 3 878 3310 7 21", "type": "text", "description": "" }, { "key": "email", "value": "1q8FWJ@UNzc.sqqy", "type": "text", "description": "" }, { "key": "website", "value": "http://kSaEVLs.umpbAJ+qIMFQfdA+HGZ.ZKJj-h5mRiuMmHWn6jSc4rZY", "type": "text", "description": "" }, { "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":false}", "type": "text", "description": "" }, { "key": "PKTextAlignmentLeft", "value": "CHAIR", "type": "text", "description": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)" }, { "key": "PKTextAlignmentCenter", "value": "INACTIVE", "type": "text", "description": " (This can only be one of ROW,INACTIVE)" }, { "key": "PKTextAlignmentRight", "value": "ARMCHAIR", "type": "text", "description": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)" } ] } }, "response": [ { "id": "9a7ee6e5-ef8c-4eb8-b1d0-a2385bb814d5", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"PENDING\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"GENERIC\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1950-06-16T09:04:46.716Z\",\n \"updatedAt\": \"1999-05-19T23:51:23.410Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeType\": \"CODE_128\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"longitude\": 3922.3535086952597,\n \"latitude\": 9931.367650701057,\n \"address\": \"string\",\n \"locationName\": \"string\"\n },\n {\n \"longitude\": 6389.100270548795,\n \"latitude\": 8430.412482627957,\n \"address\": \"string\",\n \"locationName\": \"string\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"1966-05-21T23:25:03.735Z\",\n \"updatedAt\": \"1947-06-28T02:24:16.592Z\",\n \"date\": {\n \"startDate\": \"1993-12-22T00:50:16.584Z\",\n \"endDate\": \"1996-07-21T10:44:33.461Z\",\n \"doorOpeningHour\": \"1960-09-08T02:18:12.807Z\"\n },\n \"price\": 4834.637789917176,\n \"gainUnit\": \"EURO\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": false,\n \"disableIOSPassSharing\": true,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"ACCESS\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"SEAT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2166018-c90d-4f8e-9b7e-ba67a82cb5fb", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc229372-d679-4b7d-b008-3d927936d026", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "331fba8f-5030-4874-9098-7e93ab28f8e9", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef32ab37-e7b2-47b7-a855-c8cfb27bf7c0", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38306aaa-d384-4181-909b-69ae96e450a9", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b24cfae6-6246-449d-adad-3e9393fd1fcf", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dce0ab2-22c3-413d-8f9b-41fddc4d0e61", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "PDF_417", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":8364.938426603083,\"latitude\":3181.874293608866,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2992.9189482207485,\"latitude\":7311.655231172698,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1964-01-19T19:44:18.489Z\",\"endDate\":\"2025-11-06T23:53:53.981Z\",\"doorOpeningHour\":\"1981-12-06T04:16:45.927Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "2516.092682804434", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "USD", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+4 9 82 80 2 2 05 576 9", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "YCt0qnZhf@utaoMTfIyHgifzbhLkOKUrqUhZSDlG.eb", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "http://cDUwqxUcQgZnySZ.abeAeVT8pcrtBCcPSFoWgZOsIw", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ACCESS", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "LOCATION", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a510b0a8-cd45-4864-9b45-4e9081e03baa", "name": "List events", "request": { "name": "List events", "description": { "content": "Returns the paginated list of the events in your wallet. Each event is a ticket template from which you issue passes.", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search on the event name (`name`) or its ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of items per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "86256377-7f76-414f-ba03-eae6d3b253bc", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"1965-07-03T05:09:30.458Z\",\n \"updatedAt\": \"1968-11-05T01:13:22.150Z\",\n \"date\": {\n \"value\": \"\"\n },\n \"price\": 8702.441179876581,\n \"gainUnit\": \"EURO\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"ACCESS\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"CODE_128\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"2022-10-10T22:34:46.244Z\",\n \"updatedAt\": \"1992-09-16T04:16:12.321Z\",\n \"date\": {\n \"value\": \"\"\n },\n \"price\": 1674.3118125306532,\n \"gainUnit\": \"MAD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"PRICE\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"PORT\"\n }\n ],\n \"totalDocs\": 5387.944375221449,\n \"limit\": 8489.167993961593,\n \"totalPages\": 4554.581372617368,\n \"pagingCounter\": 230.9101028538496,\n \"hasPrevPage\": true,\n \"hasNextPage\": true,\n \"page\": 7417.4964035871735,\n \"prevPage\": 298.22540321400083,\n \"nextPage\": 6901.955016274042\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8bc45e6-0a3a-4cab-bfd4-9208ce2ac110", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a256bf62-7ddc-4188-b539-4af703c963ee", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8f6f1b-d30f-4e29-a805-3539be48c680", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "645f34be-e33d-4c96-bed8-4a39b9407b0a", "name": "Update an event", "request": { "name": "Update an event", "description": { "content": "Updates an event. Only the fields you send are changed, and the template of the tickets already issued is updated accordingly. Accepts `multipart/form-data` (to change the strip image) or `application/json`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL." }, { "key": "barcodeType", "value": "AZTEC", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "name", "value": "string", "type": "text", "description": "" }, { "key": "locations", "value": "[{\"longitude\":6832.501635834867,\"latitude\":5206.142138632364,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":8770.933160707868,\"latitude\":1775.8905828493864,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text", "description": "" }, { "key": "date", "value": "{\"startDate\":\"1982-10-03T00:14:13.369Z\",\"endDate\":\"1948-02-11T08:09:29.897Z\",\"doorOpeningHour\":\"1960-11-14T17:32:16.087Z\"}", "type": "text", "description": "" }, { "key": "price", "value": "1697.6335638147552", "type": "text", "description": "" }, { "key": "gainUnit", "value": "EURO", "type": "text", "description": " (This can only be one of NONE,EURO,USD,MAD,POINTS)" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "terms", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "contactPhone", "value": "+55 047 1 6 54", "type": "text", "description": "" }, { "key": "email", "value": "4Jh1r@NNLyGywySDeYkrmrubNfUue.xw", "type": "text", "description": "" }, { "key": "website", "value": "https://yrNHOpolFhUvRACajBLD.ldbXpz3neVAIAwlPATFtmB.wog,c", "type": "text", "description": "" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text", "description": "" }, { "key": "PKTextAlignmentLeft", "value": "INACTIVE", "type": "text", "description": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)" }, { "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text", "description": " (This can only be one of ROW,INACTIVE)" }, { "key": "PKTextAlignmentRight", "value": "ARMCHAIR", "type": "text", "description": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)" } ] } }, "response": [ { "id": "39786dc3-a237-43b3-b6d7-bff8ff2a2d02", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"PENDING\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"GENERIC\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1950-06-16T09:04:46.716Z\",\n \"updatedAt\": \"1999-05-19T23:51:23.410Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeType\": \"CODE_128\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"longitude\": 3922.3535086952597,\n \"latitude\": 9931.367650701057,\n \"address\": \"string\",\n \"locationName\": \"string\"\n },\n {\n \"longitude\": 6389.100270548795,\n \"latitude\": 8430.412482627957,\n \"address\": \"string\",\n \"locationName\": \"string\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"1966-05-21T23:25:03.735Z\",\n \"updatedAt\": \"1947-06-28T02:24:16.592Z\",\n \"date\": {\n \"startDate\": \"1993-12-22T00:50:16.584Z\",\n \"endDate\": \"1996-07-21T10:44:33.461Z\",\n \"doorOpeningHour\": \"1960-09-08T02:18:12.807Z\"\n },\n \"price\": 4834.637789917176,\n \"gainUnit\": \"EURO\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": false,\n \"disableIOSPassSharing\": true,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"ACCESS\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"SEAT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d00770-08be-4ad1-81cf-98df71e6f237", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5d96969-a990-4877-a089-f8488ccdfe8c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71cd3f8f-642e-42a0-a23a-1b99783946d4", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03678bb2-39d2-4c66-ba2d-7da38aeb270d", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f92e36c7-7065-44d5-b0a1-9c8a7d268b61", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "359c43d3-b186-487b-ad61-b872eaf23be9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6751c188-938e-401a-b1c4-deab4d238ab7", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Optional strip image. In multipart/form-data: upload an image file (PNG/JPEG). In application/json: provide an image URL.", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeType", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "name", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"longitude\":3134.068229205549,\"latitude\":7469.772942763764,\"address\":\"string\",\"locationName\":\"string\"},{\"longitude\":2390.936900355722,\"latitude\":9822.783317683086,\"address\":\"string\",\"locationName\":\"string\"}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "date", "value": "{\"startDate\":\"1974-11-21T19:59:06.976Z\",\"endDate\":\"1972-09-03T10:02:21.352Z\",\"doorOpeningHour\":\"2008-02-10T08:02:14.326Z\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "price", "value": "9572.812590861353", "type": "text" }, { "description": { "content": " (This can only be one of NONE,EURO,USD,MAD,POINTS)", "type": "text/plain" }, "key": "gainUnit", "value": "NONE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "contactPhone", "value": "+8 031866 20", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "teLZcW1a8@IexVSlAMpuiWgsNwEpqnebydOGr.ze", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "website", "value": "https://NTmJvisENdOafxWhj.kcyxdz7zsFj", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text" }, { "description": { "content": " (This can only be one of CHAIR,ACCESS,PRICE,ZONE,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentLeft", "value": "ZONE", "type": "text" }, { "description": { "content": " (This can only be one of ROW,INACTIVE)", "type": "text/plain" }, "key": "PKTextAlignmentCenter", "value": "ROW", "type": "text" }, { "description": { "content": " (This can only be one of INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT)", "type": "text/plain" }, "key": "PKTextAlignmentRight", "value": "PORT", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b036cb2e-d86a-4718-9deb-550445fabdbb", "name": "Delete an event", "request": { "name": "Delete an event", "description": { "content": "Deletes an event and its ticket template. Returns the deleted event.\n\n:::info[Good to know]\n\n- Deleting an event also deletes its ticket template; this cannot be undone.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "c55d78cc-cd4e-4913-becc-f44817a07520", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"PENDING\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"GENERIC\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1950-06-16T09:04:46.716Z\",\n \"updatedAt\": \"1999-05-19T23:51:23.410Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeType\": \"CODE_128\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"longitude\": 3922.3535086952597,\n \"latitude\": 9931.367650701057,\n \"address\": \"string\",\n \"locationName\": \"string\"\n },\n {\n \"longitude\": 6389.100270548795,\n \"latitude\": 8430.412482627957,\n \"address\": \"string\",\n \"locationName\": \"string\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"1966-05-21T23:25:03.735Z\",\n \"updatedAt\": \"1947-06-28T02:24:16.592Z\",\n \"date\": {\n \"startDate\": \"1993-12-22T00:50:16.584Z\",\n \"endDate\": \"1996-07-21T10:44:33.461Z\",\n \"doorOpeningHour\": \"1960-09-08T02:18:12.807Z\"\n },\n \"price\": 4834.637789917176,\n \"gainUnit\": \"EURO\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": false,\n \"disableIOSPassSharing\": true,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"ACCESS\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"SEAT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d08fdea-2ce6-4e57-8262-9b2c18f9fec8", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93d5867-27fc-474f-b5d0-29d4b4ff20ee", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622ad2a0-3651-4fdd-8b22-f29392d9fac2", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d3ab312-be03-41b7-9367-d61d19785b81", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a62d3e74-f2f8-466c-8eb1-dcec18125147", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebc8eb21-ffd3-49bb-928c-92b0e55f019a", "name": "Get an event", "request": { "name": "Get an event", "description": { "content": "Returns the details of an event in your wallet from its ID.\n\n:::info[Good to know]\n\n- `PKTextAlignmentLeft`, `PKTextAlignmentCenter` and `PKTextAlignmentRight` define which rows each ticket must provide (`leftRow`, `centerRow`, `rightRow`). A row is required on every pass unless its alignment is set to `INACTIVE`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a80e8e71-0f70-46b1-9897-0d3d9ddb997f", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"PENDING\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"GENERIC\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1950-06-16T09:04:46.716Z\",\n \"updatedAt\": \"1999-05-19T23:51:23.410Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeType\": \"CODE_128\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"longitude\": 3922.3535086952597,\n \"latitude\": 9931.367650701057,\n \"address\": \"string\",\n \"locationName\": \"string\"\n },\n {\n \"longitude\": 6389.100270548795,\n \"latitude\": 8430.412482627957,\n \"address\": \"string\",\n \"locationName\": \"string\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"_id\": \"string\",\n \"createdAt\": \"1966-05-21T23:25:03.735Z\",\n \"updatedAt\": \"1947-06-28T02:24:16.592Z\",\n \"date\": {\n \"startDate\": \"1993-12-22T00:50:16.584Z\",\n \"endDate\": \"1996-07-21T10:44:33.461Z\",\n \"doorOpeningHour\": \"1960-09-08T02:18:12.807Z\"\n },\n \"price\": 4834.637789917176,\n \"gainUnit\": \"EURO\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": false,\n \"disableIOSPassSharing\": true,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"ACCESS\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"SEAT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8683ba21-c15b-41fe-b5bb-6cc0d62e326f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "811ea413-ca2c-4961-973f-29b8ee53d732", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b6c5d57-af95-4387-af20-9beecc32b793", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "249a344b-1b8a-49d5-b242-6be94162e2bf", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1253c33a-62d1-4f32-98f4-84bc8ceae8b5", "name": "Create an event pass", "request": { "name": "Create an event pass", "description": { "content": "Creates a ticket for an event, either for an existing client (`clientId`) or for a holder who is not a client (`firstName`, `lastName`, `email`). Returns the created pass, with its short install link.\n\n:::info[Good to know]\n\n- Send `clientId` for an existing client, or `firstName`, `lastName` and `email` otherwise. Each row (`leftRow`, `centerRow`, `rightRow`) is required unless the event sets its alignment (`PKTextAlignmentLeft`, `PKTextAlignmentCenter`, `PKTextAlignmentRight`) to `INACTIVE` (`LEFT_ROW_IS_REQUIRED`, `CENTER_ROW_IS_REQUIRED`, `RIGHT_ROW_IS_REQUIRED`). `barcode` must be unique within the event (`BARCODE_ALREADY_EXISTS`); the ticket is then sent to the holder according to the wallet's delivery settings.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d55d3bc9-05e8-4e6e-acc7-32c81ad512e2", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd902e52-c38c-43de-9a53-6bb3421ffeec", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `CENTER_ROW_IS_REQUIRED` · `RIGHT_ROW_IS_REQUIRED` · `LEFT_ROW_IS_REQUIRED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16ea0779-fdb6-486b-814f-2ef6064f5362", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b1a4d09-cb96-4077-a079-a76ef8817da0", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53eb8b1a-def8-43fc-9e7c-6ee19fad25f5", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65db272-1db6-4df0-9c82-00b1b50eb5ea", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f662778-cf17-428f-97cd-da534ceaa3a8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8199d6a9-5aa4-40cd-9499-32ce0808251f", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"Z8E-oBnQmC@lZDGxCTeEDBMTwqARfpskdkK.kr\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1e63468-347e-4274-9f04-8eece76cc830", "name": "List the passes of an event", "request": { "name": "List the passes of an event", "description": { "content": "Returns the paginated list of the passes issued for an event, with filters on status and creation date, and a text search.\n\n:::info[Good to know]\n\n- Without `status`, passes of every status are returned. For a pass linked to a client, `firstName`, `lastName`, `email` and `phoneNumber` show the client's current data.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Only returns items created on or after this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search on `firstName`, `lastName`, `email`, `barcode`, the pass ID or the client ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of items per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "44e569ae-125e-42c8-a0c8-18cad0947a61", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"coupon\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 5259.603534239949,\n \"activeAndroidDeviceCount\": 412.4312024162702,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2022-11-05T21:36:55.057Z\",\n \"updatedAt\": \"2006-01-20T13:21:56.415Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1994-01-02T07:07:36.872Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1976-12-20T11:03:14.413Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2017-03-28T19:30:45.099Z\",\n \"checkout\": \"1975-01-03T20:43:58.422Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1964-04-27T02:04:42.233Z\",\n \"originalExpirationDate\": \"1972-06-24T16:05:47.020Z\",\n \"admissionDate\": \"1989-03-23T02:41:56.561Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 3915.305914564664,\n \"activeAndroidDeviceCount\": 2320.9711025644774,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1988-10-05T00:33:56.898Z\",\n \"updatedAt\": \"1989-12-18T04:08:17.633Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1951-03-18T05:34:49.811Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1973-02-24T16:11:20.771Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2002-11-26T08:01:20.968Z\",\n \"checkout\": \"1951-06-28T09:51:12.270Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1956-12-10T16:42:41.905Z\",\n \"originalExpirationDate\": \"2021-10-10T15:15:42.145Z\",\n \"admissionDate\": \"1958-11-20T16:45:16.573Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n ],\n \"totalDocs\": 7094.688490914853,\n \"limit\": 9803.637664981445,\n \"totalPages\": 7342.415573570176,\n \"pagingCounter\": 302.93203536782,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 7181.0562155666275,\n \"prevPage\": 3881.3622460758834,\n \"nextPage\": 423.2881817674583\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1225a777-5462-4c22-8661-700f1066f2aa", "name": "`INVALID_PASS_KIND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invalid pass kind\",\n \"errorCode\": \"400:INVALID_PASS_KIND\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c017dc-c241-4150-b43e-bdbd934f4d8b", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd360bdf-65e8-440a-b772-89e5c258d381", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a190045-ed53-4fb8-9634-42b86738f104", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17af70dc-b57f-4bda-9896-603519f002e5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd5bd0f4-6e95-49cf-94a1-4ae84cc0aa08", "name": "Get an event pass", "request": { "name": "Get an event pass", "description": { "content": "Returns an event pass from its ID.\n\n:::info[Good to know]\n\n- The pass must belong to this event and to your wallet, otherwise `MODEL_NOT_FOUND` is returned.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "9285fa80-707c-480c-a7ea-af3333ee7a7d", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90e36423-aeac-4af4-a6fa-d72f0fa7e44a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34aed96a-4f3d-414f-a6cb-da0ce571a9b5", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb78a809-f94f-4435-8815-6186a5bd2a85", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee205ae8-386e-4152-b515-5519ba263df5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea017855-31a9-496a-9c7c-b69cfb85d414", "name": "Update an event pass", "request": { "name": "Update an event pass", "description": { "content": "Updates an event pass (holder, barcode, rows) and pushes the change to the installed pass. Omitted fields keep their current value.\n\n:::info[Good to know]\n\n- `clientId` cannot be changed. For a pass linked to a client, a new `firstName`, `lastName` or `barcode` is also saved on the client. A new `barcode` must be unique within the event (`BARCODE_ALREADY_EXISTS`).\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e1edb4c-2bc1-4e17-8805-7a0f7f55984d", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea3a670-2f52-45c7-a0cb-34317910fb91", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ca58626-6d78-462f-b79e-21f3529b9627", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e44f16d5-13fe-48a9-bb72-aa3558064ae3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ab4d012-b8a9-48af-8ed8-6ddd7434cfef", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efa4b8a5-b76f-4637-ba91-0a3641af6fcc", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25e1d781-1b28-4d57-a4a3-2c77fc4c9b8d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1dbc98e-9c1c-4d8c-85c4-d4af982883c2", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Event pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dfCaSzKhadWe7tV@QfdJGAqmfFvEqMLpAFnHCRW.to\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d921d46-bd2a-44c4-95dc-54e043bce501", "name": "Get an event pass by barcode", "request": { "name": "Get an event pass by barcode", "description": { "content": "Returns an event pass from its barcode value, for example after a scan at access control.\n\n:::info[Good to know]\n\n- The lookup is limited to this event: the same barcode can exist in another event.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "1c4ee1f3-5d9d-4f14-9093-7ad9dff2f126", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ac5289-c41d-4287-bc34-b7bc7c4c7d43", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfbb6a92-9ccd-4cab-aea2-fe72e0a5fa17", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0db58235-41e6-4126-96c7-1c613faf6a0b", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf45dea-0964-4456-a5fb-467c57ed7edc", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "692a971d-95b1-4fa8-89cc-30e35930172a", "name": "Update the status of an event pass by barcode", "request": { "name": "Update the status of an event pass by barcode", "description": { "content": "Marks a ticket as used (`USED`) or unused (`UNUSED`) from its barcode. Use it at access control to validate an entry, or to undo a validation.\n\n:::info[Good to know]\n\n- `USED` works like a redeem and fails with `PASS_ALREADY_REDEEMED` if the ticket is already used; `UNUSED` reverts it and fails with `PASS_NOT_REDEEMED` if it was not used. No push notification is sent to the holder.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67ba5cfe-16f9-418b-baa4-9b9486ff45e5", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6a1a1c1-ffec-4f9b-a6b6-1603f3557ec1", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `PASS_ALREADY_REDEEMED` · `PASS_NOT_REDEEMED` · `INVALID_STATUS`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f90b768-ed3d-4061-8baf-5379ae706767", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90187639-00f4-42a5-9578-e18248ab9bd0", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea5f49a-399f-4d9e-8388-6586b5a6e752", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bf4a24a-77d0-4227-b8ac-c2598d83445d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55740761-646f-41a3-9db9-dd0b00cda449", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the event." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8854423b-1c26-486d-9326-af4847e85675", "name": "Bulk create event passes", "request": { "name": "Bulk create event passes", "description": { "content": "Processed asynchronously. Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Each item follows the rules of `POST /events/{id}/passes` (rows, unique `barcode`). Up to 5,000 items; `forceSync: true` runs the operation synchronously and is limited to fewer than 1,000 items (`SYNC_EXECUTION_NOT_ALLOWED`). `webhookUrl` is called when the operation completes.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6ac3f0e0-d2b3-4de0-a2b2-c705f01c6a2a", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b36753fd-e75c-455e-b036-69057a5934e2", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `CENTER_ROW_IS_REQUIRED` · `RIGHT_ROW_IS_REQUIRED` · `LEFT_ROW_IS_REQUIRED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186fbeec-d745-41c7-bcce-8efae28e8c21", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b7e81aa-ffdd-4504-94db-8c4d0f1be745", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fae747e-7a21-403b-b2c8-c05f0cf5de3f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9025c5a-7195-4f92-824f-36581d4c0362", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c2fdfb-96b7-4976-abde-756b4d47c3be", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"GH-ik5yMB@wEhszeiT.cf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"clientId\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b506b3d1-bc53-4fb9-a0c0-77fe70ebefce", "name": "Bulk update event passes", "request": { "name": "Bulk update event passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Each item carries the `passId` to update plus the fields to change, with the same rules as `PATCH /events/{id}/passes/{passId}`. Up to 5,000 items; `forceSync: true` is limited to fewer than 1,000 items.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9abfd27f-003c-477a-8f10-916d9e0ffaa9", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db397d7-3fa4-4169-8ca1-88a85759fef8", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c69c7808-d03f-47bc-9d66-082f1149bc90", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48256e0d-8a02-4427-9896-1560e57545d6", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6abd3bcf-f7c9-4f58-b905-a9e367edfdb1", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e63599-e8bb-410b-a78a-96b1abab1306", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c4be578-2fc1-44b9-892a-4204b2ff2340", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"dg5SJ1rDG@gnTlLCgORDgxdzkaQQv.ta\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c788508-96d3-4243-8e77-4f7ea33d1280", "name": "Bulk delete event passes", "request": { "name": "Bulk delete event passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Send the IDs of the passes to delete in `passIds` (not `ids`). Deletion is permanent.\n\n:::", "type": "text/plain" }, "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed7ba532-a4ed-47de-b916-ddcf92a5edee", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da6dc39-18a1-4dc6-9df0-f368ab9a3275", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d4010c-7ecd-40bf-8982-95f02fa59b74", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1080768-c4d8-4a42-88f2-bdf409a4f785", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "664326db-aad4-4f95-83bc-6168eb35cd71", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87f3bee3-9ad5-496e-8710-5481636f7c94", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b2bb854-26e4-4907-aac6-55a9c55826f7", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "events", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Event ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/events/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d8f7a915-5c4a-4e82-99f7-e585dfd7202d", "name": "Transits", "description": { "content": "Transit tickets (bus, rail, boat, air, tram).", "type": "text/plain" }, "item": [ { "id": "43987760-f4eb-4971-aa7c-2501fabd7d75", "name": "Create a transit template", "request": { "name": "Create a transit template", "description": { "content": "Creates a transit template (bus, train, boat, air, tram or generic) and its Apple Wallet and Google Wallet pass template. Send the request as `multipart/form-data` with the `strip` image (required); the template's `number` is the default trip number of its passes.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "(Required) " }, { "key": "terms", "value": "string", "type": "text", "description": "(Required) " }, { "key": "originStationCode", "value": "string", "type": "text", "description": "(Required) " }, { "key": "originName", "value": "string", "type": "text", "description": "(Required) " }, { "key": "destinationStationCode", "value": "string", "type": "text", "description": "(Required) " }, { "key": "destinationName", "value": "string", "type": "text", "description": "(Required) " }, { "key": "departureTime", "value": "20:56", "type": "text", "description": "(Required) " }, { "key": "arrivalTime", "value": "06:59Z", "type": "text", "description": "(Required) " }, { "key": "details", "value": "string", "type": "text", "description": "(Required) " }, { "key": "number", "value": "7465.667955325916", "type": "text", "description": "(Required) " }, { "key": "type", "value": "Tram", "type": "text", "description": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)" }, { "key": "barcodeFormat", "value": "CODE_128", "type": "text", "description": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "(Required) " }, { "key": "customerServiceNumber", "value": "string", "type": "text", "description": "" }, { "key": "tarif", "value": "string", "type": "text", "description": "" }, { "key": "gateName", "value": "N_VOYAGE", "type": "text", "description": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)" }, { "key": "seatName", "value": "PLAQUE", "type": "text", "description": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "locations", "value": "[{\"latitude\":8062.991220931721,\"longitude\":4967.558120101648},{\"latitude\":8582.758199858736,\"longitude\":559.0171610717575}]", "type": "text", "description": "" }, { "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text", "description": "" }, { "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text", "description": "" }, { "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"CUSTOM_TEXT\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "9cd6a96e-76c7-4477-a37e-ac6f60e74f7a", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"STORE_CARD\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2009-11-17T17:37:59.334Z\",\n \"updatedAt\": \"2002-07-07T02:39:34.942Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Air\",\n \"_id\": \"string\",\n \"createdAt\": \"1999-05-30T09:14:36.776Z\",\n \"updatedAt\": \"1971-08-11T20:49:24.509Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"longitude\": 5736.007187582488,\n \"latitude\": 7241.28019297287,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n },\n {\n \"longitude\": 8601.680404085939,\n \"latitude\": 9399.32968080521,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": true,\n \"disableIOSPassSharing\": false,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": false,\n \"hideStationCodes\": false,\n \"hideTripNumber\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"FULLNAME\",\n \"valueEnum\": \"TRIP_NUMBER\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50a7c488-1662-4f5d-b5bb-9935502f25dd", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8749253a-e7c4-488f-96f3-42d24d671641", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb54a46-b677-4033-a585-798f85ce1922", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14fe09c1-3253-4c1f-ac20-9fe1819bd399", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf9c91ad-4713-45c6-aa7c-8118b3220119", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "departureTime", "value": "23:12Z", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "arrivalTime", "value": "23:39", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "number", "value": "2582.617226530497", "type": "text" }, { "description": { "content": "(Required) (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Boat", "type": "text" }, { "description": { "content": "(Required) (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "CODE_128", "type": "text" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "PLAQUE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":4066.867549362432,\"longitude\":8135.242137034115},{\"latitude\":7580.199508405274,\"longitude\":5806.30921511871}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"FULLNAME\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cdbe4f0-6693-498c-b6a0-1651fb3b5e80", "name": "List transit templates", "request": { "name": "List transit templates", "description": { "content": "Lists, page by page, the wallet's transit templates of a given type (`type` is required: `Bus`, `Boat`, `Train`, `Air`, `Generic` or `Tram`).\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "type", "value": "Tram", "description": "(Required) Transit type (required): `Bus`, `Boat`, `Train`, `Air`, `Generic` or `Tram`." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial match on the template ID (`_id`)." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of templates per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "017da316-5be1-4c6d-ae0d-cf8653eb692a", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "Tram" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"CODE_128\",\n \"terms\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Boat\",\n \"_id\": \"string\",\n \"createdAt\": \"1960-09-05T11:35:36.027Z\",\n \"updatedAt\": \"2010-10-12T02:03:42.228Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"N_VOYAGE\",\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Train\",\n \"_id\": \"string\",\n \"createdAt\": \"1959-02-07T02:00:03.047Z\",\n \"updatedAt\": \"2003-10-29T22:17:22.415Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"PLAQUE\",\n \"seatName\": \"N_VOYAGE\",\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n }\n ],\n \"totalDocs\": 1142.6448039299264,\n \"limit\": 522.7576900502462,\n \"totalPages\": 5470.456222267841,\n \"pagingCounter\": 1194.6092192090641,\n \"hasPrevPage\": true,\n \"hasNextPage\": true,\n \"page\": 7411.1117515893875,\n \"prevPage\": 2143.8053691923333,\n \"nextPage\": 8049.628078524204\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddd34a3e-30de-4699-a971-904b3a9aff3f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "Tram" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82931fc7-f114-4fef-b315-55dce39772aa", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "Tram" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "064c014f-9c94-4a95-a594-619e738b3d8a", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "Tram" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8219e011-3115-4726-bf8b-44f6e358738e", "name": "Update a transit template", "request": { "name": "Update a transit template", "description": { "content": "Updates a transit template; passes already installed are updated. Holders are notified according to the `UPDATE_TRANSIT` notification template. Accepts `multipart/form-data` (new `strip` image) or `application/json`.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "" }, { "key": "terms", "value": "string", "type": "text", "description": "" }, { "key": "customerServiceNumber", "value": "string", "type": "text", "description": "" }, { "key": "originStationCode", "value": "string", "type": "text", "description": "" }, { "key": "originName", "value": "string", "type": "text", "description": "" }, { "key": "destinationStationCode", "value": "string", "type": "text", "description": "" }, { "key": "destinationName", "value": "string", "type": "text", "description": "" }, { "key": "departureTime", "value": "09:46", "type": "text", "description": "" }, { "key": "arrivalTime", "value": "04:26", "type": "text", "description": "" }, { "key": "tarif", "value": "string", "type": "text", "description": "" }, { "key": "details", "value": "string", "type": "text", "description": "" }, { "key": "number", "value": "8573.02523873865", "type": "text", "description": "" }, { "key": "type", "value": "Air", "type": "text", "description": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)" }, { "key": "gateName", "value": "N_VOYAGE", "type": "text", "description": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)" }, { "key": "seatName", "value": "N_CABINE", "type": "text", "description": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)" }, { "key": "emailSubscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "subscriptionMessage", "value": "string", "type": "text", "description": "" }, { "key": "barcodeFormat", "value": "NONE", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "locations", "value": "[{\"latitude\":2164.412018234645,\"longitude\":6952.454200131721},{\"latitude\":5395.965119363677,\"longitude\":9877.531261186607}]", "type": "text", "description": "" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "security", "value": "{\"enableOneTimeUse\":true,\"disableIOSPassSharing\":true,\"disablePassLinkSharing\":false,\"disableMultipleHolders\":true,\"enableSecurityAnimation\":false,\"enableRotatingBarcode\":false}", "type": "text", "description": "" }, { "key": "displayOptions", "value": "{\"hideTarif\":false,\"hideStationCodes\":true,\"hideTripNumber\":false}", "type": "text", "description": "" }, { "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "aee546c6-ab67-4fd2-bf39-5f1e017e2936", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"STORE_CARD\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2009-11-17T17:37:59.334Z\",\n \"updatedAt\": \"2002-07-07T02:39:34.942Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Air\",\n \"_id\": \"string\",\n \"createdAt\": \"1999-05-30T09:14:36.776Z\",\n \"updatedAt\": \"1971-08-11T20:49:24.509Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"longitude\": 5736.007187582488,\n \"latitude\": 7241.28019297287,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n },\n {\n \"longitude\": 8601.680404085939,\n \"latitude\": 9399.32968080521,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": true,\n \"disableIOSPassSharing\": false,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": false,\n \"hideStationCodes\": false,\n \"hideTripNumber\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"FULLNAME\",\n \"valueEnum\": \"TRIP_NUMBER\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26baaacc-bd5d-4ea8-9e25-42af8668c637", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "901e2ee1-08e5-4e6b-a26b-63707c8e1483", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbf0a82-d85d-4ecf-a143-60585468ae53", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cb18aa8-3386-4aec-a29a-5fcadd7ece25", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09f3d7b6-16f1-4a4d-94a9-3f8113c0f069", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c96b4cb-fac9-4ebc-883d-a48ce8b5eed6", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f435e042-11d9-48d7-bcf6-ec2b5052a721", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "terms", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "customerServiceNumber", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "originName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationStationCode", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "destinationName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "departureTime", "value": "10:17", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "arrivalTime", "value": "21:51", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "tarif", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "details", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "number", "value": "4779.698948478676", "type": "text" }, { "description": { "content": " (This can only be one of Bus,Boat,Train,Air,Generic,Tram)", "type": "text/plain" }, "key": "type", "value": "Tram", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "gateName", "value": "N_VOYAGE", "type": "text" }, { "description": { "content": " (This can only be one of N_CABINE,N_VOYAGE,PLAQUE)", "type": "text/plain" }, "key": "seatName", "value": "PLAQUE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "emailSubscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "subscriptionMessage", "value": "string", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "locations", "value": "[{\"latitude\":2224.5364181151617,\"longitude\":2706.851496319551},{\"latitude\":2549.5277075787735,\"longitude\":5084.147614457959}]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "security", "value": "{\"enableOneTimeUse\":false,\"disableIOSPassSharing\":false,\"disablePassLinkSharing\":true,\"disableMultipleHolders\":false,\"enableSecurityAnimation\":true,\"enableRotatingBarcode\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "displayOptions", "value": "{\"hideTarif\":true,\"hideStationCodes\":false,\"hideTripNumber\":true}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "iosHeader", "value": "{\"labelEnum\":\"TRIP_NUMBER\",\"valueEnum\":\"TRIP_NUMBER\",\"customLabel\":\"string\",\"customValue\":\"string\"}", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ede20cda-3e92-4036-8c24-f4632be84f37", "name": "Delete a transit template", "request": { "name": "Delete a transit template", "description": { "content": "Deletes a transit template and its pass template. Deletion is refused (`400 HOTEL_HAS_PASSES`) while passes exist for this template.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "74bf30d9-9854-4451-99f6-974d80954122", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"STORE_CARD\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2009-11-17T17:37:59.334Z\",\n \"updatedAt\": \"2002-07-07T02:39:34.942Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Air\",\n \"_id\": \"string\",\n \"createdAt\": \"1999-05-30T09:14:36.776Z\",\n \"updatedAt\": \"1971-08-11T20:49:24.509Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"longitude\": 5736.007187582488,\n \"latitude\": 7241.28019297287,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n },\n {\n \"longitude\": 8601.680404085939,\n \"latitude\": 9399.32968080521,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": true,\n \"disableIOSPassSharing\": false,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": false,\n \"hideStationCodes\": false,\n \"hideTripNumber\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"FULLNAME\",\n \"valueEnum\": \"TRIP_NUMBER\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2131c505-8b6c-4c7a-a1f4-8aacc01d56bb", "name": "`HOTEL_HAS_PASSES`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel has passes!\",\n \"errorCode\": \"400:HOTEL_HAS_PASSES\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d75c727-cdca-4673-a903-0f7a67a6ec6b", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7dc7ffc-732e-4142-9af8-f2b9e4fe22f9", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92cacc4e-252c-486f-a579-f560e14e2204", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb3d371-65cc-4174-90e0-1a196f032638", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "235ac7a3-fedf-4a2a-9d96-35eb440391bd", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1fa2911-827f-4b69-a666-59298a5c0cdc", "name": "Get a transit template", "request": { "name": "Get a transit template", "description": { "content": "Returns one of the wallet's transit templates by its ID.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e558b197-de67-4a49-9809-a61c79be5d3e", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"STORE_CARD\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2009-11-17T17:37:59.334Z\",\n \"updatedAt\": \"2002-07-07T02:39:34.942Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Air\",\n \"_id\": \"string\",\n \"createdAt\": \"1999-05-30T09:14:36.776Z\",\n \"updatedAt\": \"1971-08-11T20:49:24.509Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"longitude\": 5736.007187582488,\n \"latitude\": 7241.28019297287,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n },\n {\n \"longitude\": 8601.680404085939,\n \"latitude\": 9399.32968080521,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": true,\n \"disableIOSPassSharing\": false,\n \"disablePassLinkSharing\": true,\n \"disableMultipleHolders\": true,\n \"enableSecurityAnimation\": false,\n \"enableRotatingBarcode\": true\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": false,\n \"hideStationCodes\": false,\n \"hideTripNumber\": true\n },\n \"iosHeader\": {\n \"labelEnum\": \"FULLNAME\",\n \"valueEnum\": \"TRIP_NUMBER\",\n \"customLabel\": \"string\",\n \"customValue\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "601ce07c-5437-4b4a-be70-acf57c0a07b4", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9682a5ac-237e-4ebf-8e4a-ffe6bc64f58b", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc15014f-3a92-4259-af46-be866f7cca4f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a50df61-700c-415d-847f-355b84f516b5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52b81b81-21f0-4c5f-8445-05e51172e54a", "name": "Create a transit pass", "request": { "name": "Create a transit pass", "description": { "content": "Creates a transit ticket for a traveller from a transit template and returns its ID, barcode and download link (`downloadLink`). With `enableSendEmailOrSms: true`, the ticket is also sent by email or SMS (`email` or `phoneNumber`).\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"41eHoIuy0uZwH@dEkYsVxuHXeKfCrKhDPmkHeoXYnQycf.bdre\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1b96bed0-28d8-4537-8eda-e4f4a0cca7c1", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"string\",\n \"downloadLink\": \"string\",\n \"name\": \"string\",\n \"barcode\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f838ea1-2634-4f39-8ae1-b761c3043b3c", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72eecae2-b39d-4c00-a862-313c3f2c2c8a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5268d5-46b7-4fa0-ae75-e5f8e82e8d68", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1c32020-166d-49ff-b64f-1c19068783ce", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a7c0bc-9f54-4a04-9845-7a71c64ad478", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "174e0cdd-35b2-48dc-9ed2-1e0497d74bf8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf935163-51cc-4ab2-981a-83d7bbbdddeb", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"C4KDVWugM@Szjc.dbys\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "075281d4-2729-455f-a3ed-b1db5b55254a", "name": "List the passes of a transit", "request": { "name": "List the passes of a transit", "description": { "content": "Lists, page by page, the passes of a transit template, with filters on status, creation date and search. Each pass includes `departureDateTime`, `arrivalDateTime` (format `dd-MM-yyyy HH:mm`) and the device types it is installed on (`devices`).\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Accepted, but the list is always sorted by creation date, newest first." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Only returns passes created on or after this date (ISO 8601)." }, { "disabled": false, "key": "search", "value": "string", "description": "Partial match on first name, last name, email, barcode, or the pass or client ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Accepted, but the list is always sorted by creation date, newest first." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of passes per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "643fec5f-f9eb-43b5-8b2d-edc44fe83427", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"coupon\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 5259.603534239949,\n \"activeAndroidDeviceCount\": 412.4312024162702,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2022-11-05T21:36:55.057Z\",\n \"updatedAt\": \"2006-01-20T13:21:56.415Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1994-01-02T07:07:36.872Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1976-12-20T11:03:14.413Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2017-03-28T19:30:45.099Z\",\n \"checkout\": \"1975-01-03T20:43:58.422Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1964-04-27T02:04:42.233Z\",\n \"originalExpirationDate\": \"1972-06-24T16:05:47.020Z\",\n \"admissionDate\": \"1989-03-23T02:41:56.561Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 3915.305914564664,\n \"activeAndroidDeviceCount\": 2320.9711025644774,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1988-10-05T00:33:56.898Z\",\n \"updatedAt\": \"1989-12-18T04:08:17.633Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1951-03-18T05:34:49.811Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1973-02-24T16:11:20.771Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2002-11-26T08:01:20.968Z\",\n \"checkout\": \"1951-06-28T09:51:12.270Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1956-12-10T16:42:41.905Z\",\n \"originalExpirationDate\": \"2021-10-10T15:15:42.145Z\",\n \"admissionDate\": \"1958-11-20T16:45:16.573Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n ],\n \"totalDocs\": 7094.688490914853,\n \"limit\": 9803.637664981445,\n \"totalPages\": 7342.415573570176,\n \"pagingCounter\": 302.93203536782,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 7181.0562155666275,\n \"prevPage\": 3881.3622460758834,\n \"nextPage\": 423.2881817674583\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "caae553f-a872-4f31-9255-e232a1d53a4f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "923aa966-e4e6-4998-ad22-5e66311f3a6f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb586d85-51ad-488c-86c9-6e71058b8336", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f760b153-aac1-4cee-80fe-0147983375d4", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a759ec77-c9b3-45f5-bde3-b54eac9faeb7", "name": "Get a transit pass", "request": { "name": "Get a transit pass", "description": { "content": "Returns a transit ticket by its ID.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "26e6b0dc-58df-4f3d-a5ac-51e85c8c59b9", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe0cd89c-ba93-4cfa-99dc-84c662966547", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155033f1-208a-4bac-aa7d-922d007aba1f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03fc0101-6ac8-45cd-9893-a5ba0d40385b", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "965e5861-4cb6-4fe4-8569-2261be58f08f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ed71e30-1ca2-46f0-a8ba-b62091b357f2", "name": "Update a transit pass", "request": { "name": "Update a transit pass", "description": { "content": "Updates a transit ticket (traveller, trip, times, seat, barcode…) and the installed pass. The holder is notified according to the `UPDATE_TRANSIT` template and their preferences; a request with no change returns the pass as is.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"PHU3P5NK90xzvt4@kRxnOfpIdqcuk.qwra\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67621447-ecf0-457c-b351-f87ece69f7d4", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10626cab-1425-49e2-b4ac-e23f477ea6e5", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83813f74-cb54-442a-8ecc-991bd2724fb0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92545624-8abd-46bf-81e1-05dba84209e3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa4bb91d-4411-4d88-adae-b3cc681a98bc", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c062e4b-c23c-44a7-8b2a-876ab467888f", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ea43c2-5167-430b-9b07-a8d05a33ea0f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6644c086-92a2-45dc-a756-aade9edfcff7", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Pass ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"sYE@ipCTg.kl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n },\n {\n \"label\": \"string\",\n \"value\": \"string\",\n \"type\": {},\n \"key\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c35c201b-7875-4378-a3d5-58a499b0fb67", "name": "Get a transit pass by barcode", "request": { "name": "Get a transit pass by barcode", "description": { "content": "Returns a transit ticket by its barcode, for example during a ticket check.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f240b399-afc0-4314-934c-ec5ee5e44f3d", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98f796ec-5601-4a35-8e3d-b9725f4080aa", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "054d2b67-1550-4371-96ff-0575839e4bcf", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d5c0257-3aac-4b00-956f-065c9aca58f2", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a984b5e-0446-4a8e-81f0-df90efb5b869", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "barcode", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/barcode/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dce9da3a-276b-446a-9df1-5d899e1e89e3", "name": "Update the status of a transit pass by barcode", "request": { "name": "Update the status of a transit pass by barcode", "description": { "content": "Marks a transit ticket as used (`status: USED`) or cancels that validation (`status: UNUSED`), by its barcode. The installed pass is updated without notification; returns `PASS_ALREADY_REDEEMED` or `PASS_NOT_REDEEMED` when the status does not change.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "62b420ef-7550-46b3-8104-078e219c023b", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd51a61a-f6ad-495b-9390-1266f4f5c4af", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `PASS_ALREADY_REDEEMED` · `PASS_NOT_REDEEMED` · `INVALID_STATUS`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776be674-c621-436d-8310-1a698531e24d", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1845cdab-08f3-4604-96dc-ecb9a97e85b3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71666010-508b-4109-b5fd-9900ffce1840", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fc68083-4b32-42b7-91e4-3c9b4907003f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b435794a-ce87-4bb4-8082-0dddcf35ea53", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", ":barcode", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Barcode value of the pass, unique within the transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"USED\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes/:barcode/status\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2614c6ed-44fd-4999-a789-11ce4ccdf115", "name": "Get transit statistics", "request": { "name": "Get transit statistics", "description": { "content": "Returns statistics on the wallet's transit tickets: total (`totalCustomers`), active (`totalActifCustomers`) and redeemed (`redeemedPassesCount`). Filter by template, transit type or creation period.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "transitId", "value": "string", "description": "Limits the statistics to this transit template. Takes precedence over `transitType`." }, { "disabled": false, "key": "transitType", "value": "Tram", "description": "Limits the statistics to templates of this type: `Bus`, `Boat`, `Train`, `Air`, `Generic` or `Tram`." }, { "disabled": false, "key": "startDate", "value": "1990-11-17T07:48:38.378Z", "description": "Start of the period (ISO 8601), applied to the passes' creation date." }, { "disabled": false, "key": "endDate", "value": "1990-11-17T07:48:38.378Z", "description": "End of the period (ISO 8601), applied to the passes' creation date." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "bf33681b-4da3-4a03-b1de-981cf2a6e053", "originalRequest": { "url": { "path": [ "transits", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "transitId", "value": "string" }, { "key": "transitType", "value": "Tram" }, { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"totalCustomers\": 746.7632793583267,\n \"totalActifCustomers\": 9900.931806164961,\n \"redeemedPassesCount\": 156.7643774390004\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5103fa6a-6697-43e2-a92f-b4ed6e913d33", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "transitId", "value": "string" }, { "key": "transitType", "value": "Tram" }, { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10de1435-a6e2-4299-b01c-59fff5bc073c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "transitId", "value": "string" }, { "key": "transitType", "value": "Tram" }, { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212bbc63-b9c8-4131-ba3f-d8a037ade5ad", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "transitId", "value": "string" }, { "key": "transitType", "value": "Tram" }, { "key": "startDate", "value": "1990-11-17T07:48:38.378Z" }, { "key": "endDate", "value": "1990-11-17T07:48:38.378Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c533a38d-ae05-4da1-8c44-b21a2f3b7a6d", "name": "Bulk create transit passes", "request": { "name": "Bulk create transit passes", "description": { "content": "Processed asynchronously. Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "abe9075a-c36a-4ad0-a4bc-4fa7982c54c7", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a04ea3f-0ca3-4dc1-bf49-92df2aaa12fb", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7bed216-39a7-4432-b928-08b87026071a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64b30850-34bf-4105-98d5-d467d1f2a7cb", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ea9155f-f3ef-44ff-9a84-d086a825a158", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "262f4c89-ec67-4669-a8bf-6383478a1818", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a34be2f1-9445-4056-986a-c486a6fb7645", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"0fmpmT2Mh@uQCvV.qnm\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false,\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"enableSendEmailOrSms\": true,\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d027b470-483e-492d-97cd-e40e9508d71f", "name": "Bulk update transit passes", "request": { "name": "Bulk update transit passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"EHBUB2oH5ybAWSV@WDKLb.dgsl\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "84b85c9c-bab4-4ea5-81f5-cc3574ebee80", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2126fb2e-6363-43be-95af-1c0be48322a9", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a751ecf-3972-44fc-b1b3-b26e5db4101d", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a043304e-b009-4132-81aa-2ef32673e453", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e6da30-b9e8-4ce9-a500-951d652f588e", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b147e5ac-6008-44da-b58c-ccbea0cf98dc", "name": "`BARCODE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Barcode already exists\",\n \"errorCode\": \"409:BARCODE_ALREADY_EXISTS\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28064ab8-a87f-4135-928e-815e6adf3f3c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"departureDate\": \"2000-01-01\",\n \"arrivalDate\": \"2000-01-01\",\n \"departureTime\": \"00:00\",\n \"arrivalTime\": \"01:00\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"expirationDate\": \"2000-01-01\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"b7TgJpKVUFAONtW@DCeYzzfeaDQqIZePLVZdHfqzflK.yqqz\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"flightNumber\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"tripNumber\": \"string\",\n \"tarif\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"enableSendEmailOrSms\": false\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fcb874e3-efe0-4133-8f7d-f8ac575403cc", "name": "Bulk delete transit passes", "request": { "name": "Bulk delete transit passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5355b06e-102e-4efb-8c36-f0b3ed5471ec", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964e9731-3b8a-4348-b565-9cec0ec2073f", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e4d309-f96f-42d3-8407-1a98817c3b76", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95673aab-0e17-454c-a7ab-731125d4902f", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3007c6d-ae01-4261-9322-9f99d3112496", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3be85ac-4c50-4a43-965c-15b320151b8d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d971da7-9496-46c7-8443-145d3c0e5399", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dcda15e1-53ef-4331-b66b-e0948d796c9b", "name": "Update a trip", "request": { "name": "Update a trip", "description": { "content": "Updates the transit passes that share this trip number.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n- `arrivalDate` is required when `departureDate` is set.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2df7a058-95e3-4b98-a2ce-b0d8024709ef", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"advantages\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"hotelName\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"location\": {\n \"value\": \"\"\n }\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n },\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n }\n ],\n \"activeIOSDeviceCount\": 1386.9261085629048,\n \"activeAndroidDeviceCount\": 4666.282513357778,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2015-10-11T07:04:21.401Z\",\n \"updatedAt\": \"2015-02-25T05:37:48.676Z\",\n \"client\": {\n \"source\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"companyName\": {\n \"value\": \"\"\n },\n \"renewalDate\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"admissionDate\": {\n \"value\": \"\"\n },\n \"gain\": {\n \"value\": \"\"\n },\n \"gainHistory\": {\n \"value\": \"\"\n },\n \"communicationPreferences\": {\n \"value\": \"\"\n },\n \"pushInformativeEnabled\": {\n \"value\": \"\"\n },\n \"pushCommercialEnabled\": {\n \"value\": \"\"\n }\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": {\n \"value\": \"\"\n },\n \"originName\": {\n \"value\": \"\"\n },\n \"destinationStationCode\": {\n \"value\": \"\"\n },\n \"destinationName\": {\n \"value\": \"\"\n },\n \"departureTime\": {\n \"value\": \"\"\n },\n \"arrivalTime\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"customerServiceNumber\": {\n \"value\": \"\"\n },\n \"tarif\": {\n \"value\": \"\"\n },\n \"gateName\": {\n \"value\": \"\"\n },\n \"seatName\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"customBackFields\": {\n \"value\": \"\"\n },\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"event\": {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"contactPhone\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentLeft\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentCenter\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentRight\": {\n \"value\": \"\"\n }\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"descriptions\": {\n \"value\": \"\"\n },\n \"openingHours\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"oneTimeToUse\": {\n \"value\": \"\"\n },\n \"sharingProhibited\": {\n \"value\": \"\"\n },\n \"sharingProhibitedAndroid\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n },\n \"gainLabel\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"offerLabel\": {\n \"value\": \"\"\n },\n \"enableDisplayIdentifiant\": {\n \"value\": \"\"\n },\n \"gainFormatMigrated\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"displayWalletName\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"programName\": {\n \"value\": \"\"\n },\n \"keysHasChanged\": {\n \"value\": \"\"\n },\n \"startRow\": {\n \"value\": \"\"\n },\n \"middleRow\": {\n \"value\": \"\"\n },\n \"endRow\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isMultipleInstance\": {\n \"value\": \"\"\n },\n \"isWelcomeCoupon\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"promoCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1948-07-10T09:50:29.765Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1968-01-03T07:40:48.635Z\",\n \"instanceId\": {},\n \"checkin\": \"1982-12-11T01:52:02.251Z\",\n \"checkout\": \"2013-11-07T03:09:05.252Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1971-03-10T22:00:08.836Z\",\n \"originalExpirationDate\": \"2022-07-08T23:35:56.841Z\",\n \"admissionDate\": \"1958-06-08T15:46:16.676Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"advantages\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"hotelName\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"location\": {\n \"value\": \"\"\n }\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n },\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n }\n ],\n \"activeIOSDeviceCount\": 1879.046914570688,\n \"activeAndroidDeviceCount\": 4374.8724074119045,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1996-11-24T05:15:52.207Z\",\n \"updatedAt\": \"1982-12-15T22:30:02.454Z\",\n \"client\": {\n \"source\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"companyName\": {\n \"value\": \"\"\n },\n \"renewalDate\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"admissionDate\": {\n \"value\": \"\"\n },\n \"gain\": {\n \"value\": \"\"\n },\n \"gainHistory\": {\n \"value\": \"\"\n },\n \"communicationPreferences\": {\n \"value\": \"\"\n },\n \"pushInformativeEnabled\": {\n \"value\": \"\"\n },\n \"pushCommercialEnabled\": {\n \"value\": \"\"\n }\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": {\n \"value\": \"\"\n },\n \"originName\": {\n \"value\": \"\"\n },\n \"destinationStationCode\": {\n \"value\": \"\"\n },\n \"destinationName\": {\n \"value\": \"\"\n },\n \"departureTime\": {\n \"value\": \"\"\n },\n \"arrivalTime\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"customerServiceNumber\": {\n \"value\": \"\"\n },\n \"tarif\": {\n \"value\": \"\"\n },\n \"gateName\": {\n \"value\": \"\"\n },\n \"seatName\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"customBackFields\": {\n \"value\": \"\"\n },\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"event\": {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"contactPhone\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentLeft\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentCenter\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentRight\": {\n \"value\": \"\"\n }\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"descriptions\": {\n \"value\": \"\"\n },\n \"openingHours\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"oneTimeToUse\": {\n \"value\": \"\"\n },\n \"sharingProhibited\": {\n \"value\": \"\"\n },\n \"sharingProhibitedAndroid\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n },\n \"gainLabel\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"offerLabel\": {\n \"value\": \"\"\n },\n \"enableDisplayIdentifiant\": {\n \"value\": \"\"\n },\n \"gainFormatMigrated\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"displayWalletName\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"programName\": {\n \"value\": \"\"\n },\n \"keysHasChanged\": {\n \"value\": \"\"\n },\n \"startRow\": {\n \"value\": \"\"\n },\n \"middleRow\": {\n \"value\": \"\"\n },\n \"endRow\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isMultipleInstance\": {\n \"value\": \"\"\n },\n \"isWelcomeCoupon\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"promoCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1998-01-08T00:15:14.260Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1984-12-26T23:23:35.994Z\",\n \"instanceId\": {},\n \"checkin\": \"2002-04-12T21:59:49.047Z\",\n \"checkout\": \"1958-06-20T07:30:34.967Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-05-03T08:04:41.584Z\",\n \"originalExpirationDate\": \"2000-10-03T00:46:31.445Z\",\n \"admissionDate\": \"1948-04-08T20:22:41.098Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eed7806c-618c-4ed7-8fc4-bdc209718870", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d157417-3cf4-4600-95dd-c9549cd0325c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b7c5b47-4b28-45ed-a7e7-d5e74bf3085e", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dfbab4a-f007-423c-be19-67bf2de9193f", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c83c594-74fa-4003-bad7-33917db33404", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "014ba605-274b-45bb-9841-349d962d8813", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to update. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"departureTime\": \"13:09\",\n \"arrivalTime\": \"22:07\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"str\",\n \"destinationStationCode\": \"str\",\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"expirationDate\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd8c6906-adff-4bde-ad10-3f7cbb3d145f", "name": "Notify the holders of a trip", "request": { "name": "Notify the holders of a trip", "description": { "content": "Sends a notification to the holders of the passes with this trip number.\n\n:::info[Good to know]\n\n- The wallet must have the **TRANSIT** pass type enabled.\n\n:::", "type": "text/plain" }, "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "728af505-6244-4961-bb22-e299cfc68632", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"advantages\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"hotelName\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"location\": {\n \"value\": \"\"\n }\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n },\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n }\n ],\n \"activeIOSDeviceCount\": 1386.9261085629048,\n \"activeAndroidDeviceCount\": 4666.282513357778,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2015-10-11T07:04:21.401Z\",\n \"updatedAt\": \"2015-02-25T05:37:48.676Z\",\n \"client\": {\n \"source\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"companyName\": {\n \"value\": \"\"\n },\n \"renewalDate\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"admissionDate\": {\n \"value\": \"\"\n },\n \"gain\": {\n \"value\": \"\"\n },\n \"gainHistory\": {\n \"value\": \"\"\n },\n \"communicationPreferences\": {\n \"value\": \"\"\n },\n \"pushInformativeEnabled\": {\n \"value\": \"\"\n },\n \"pushCommercialEnabled\": {\n \"value\": \"\"\n }\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": {\n \"value\": \"\"\n },\n \"originName\": {\n \"value\": \"\"\n },\n \"destinationStationCode\": {\n \"value\": \"\"\n },\n \"destinationName\": {\n \"value\": \"\"\n },\n \"departureTime\": {\n \"value\": \"\"\n },\n \"arrivalTime\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"customerServiceNumber\": {\n \"value\": \"\"\n },\n \"tarif\": {\n \"value\": \"\"\n },\n \"gateName\": {\n \"value\": \"\"\n },\n \"seatName\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"customBackFields\": {\n \"value\": \"\"\n },\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"event\": {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"contactPhone\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentLeft\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentCenter\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentRight\": {\n \"value\": \"\"\n }\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"descriptions\": {\n \"value\": \"\"\n },\n \"openingHours\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"oneTimeToUse\": {\n \"value\": \"\"\n },\n \"sharingProhibited\": {\n \"value\": \"\"\n },\n \"sharingProhibitedAndroid\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n },\n \"gainLabel\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"offerLabel\": {\n \"value\": \"\"\n },\n \"enableDisplayIdentifiant\": {\n \"value\": \"\"\n },\n \"gainFormatMigrated\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"displayWalletName\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"programName\": {\n \"value\": \"\"\n },\n \"keysHasChanged\": {\n \"value\": \"\"\n },\n \"startRow\": {\n \"value\": \"\"\n },\n \"middleRow\": {\n \"value\": \"\"\n },\n \"endRow\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isMultipleInstance\": {\n \"value\": \"\"\n },\n \"isWelcomeCoupon\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"promoCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1948-07-10T09:50:29.765Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1968-01-03T07:40:48.635Z\",\n \"instanceId\": {},\n \"checkin\": \"1982-12-11T01:52:02.251Z\",\n \"checkout\": \"2013-11-07T03:09:05.252Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1971-03-10T22:00:08.836Z\",\n \"originalExpirationDate\": \"2022-07-08T23:35:56.841Z\",\n \"admissionDate\": \"1958-06-08T15:46:16.676Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"advantages\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"hotelName\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"location\": {\n \"value\": \"\"\n }\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n },\n {\n \"deviceLibraryIdentifier\": {\n \"value\": \"\"\n },\n \"deviceType\": {\n \"value\": \"\"\n },\n \"registeredAt\": {\n \"value\": \"\"\n },\n \"isDeleted\": {\n \"value\": \"\"\n }\n }\n ],\n \"activeIOSDeviceCount\": 1879.046914570688,\n \"activeAndroidDeviceCount\": 4374.8724074119045,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n },\n {\n \"instanceId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n }\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1996-11-24T05:15:52.207Z\",\n \"updatedAt\": \"1982-12-15T22:30:02.454Z\",\n \"client\": {\n \"source\": {\n \"value\": \"\"\n },\n \"firstName\": {\n \"value\": \"\"\n },\n \"lastName\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"companyName\": {\n \"value\": \"\"\n },\n \"renewalDate\": {\n \"value\": \"\"\n },\n \"phoneNumber\": {\n \"value\": \"\"\n },\n \"birthDate\": {\n \"value\": \"\"\n },\n \"admissionDate\": {\n \"value\": \"\"\n },\n \"gain\": {\n \"value\": \"\"\n },\n \"gainHistory\": {\n \"value\": \"\"\n },\n \"communicationPreferences\": {\n \"value\": \"\"\n },\n \"pushInformativeEnabled\": {\n \"value\": \"\"\n },\n \"pushCommercialEnabled\": {\n \"value\": \"\"\n }\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"originStationCode\": {\n \"value\": \"\"\n },\n \"originName\": {\n \"value\": \"\"\n },\n \"destinationStationCode\": {\n \"value\": \"\"\n },\n \"destinationName\": {\n \"value\": \"\"\n },\n \"departureTime\": {\n \"value\": \"\"\n },\n \"arrivalTime\": {\n \"value\": \"\"\n },\n \"details\": {\n \"value\": \"\"\n },\n \"number\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"customerServiceNumber\": {\n \"value\": \"\"\n },\n \"tarif\": {\n \"value\": \"\"\n },\n \"gateName\": {\n \"value\": \"\"\n },\n \"seatName\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"customBackFields\": {\n \"value\": \"\"\n },\n \"displayOptions\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"event\": {\n \"status\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"locations\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"date\": {\n \"value\": \"\"\n },\n \"price\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"terms\": {\n \"value\": \"\"\n },\n \"contactPhone\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentLeft\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentCenter\": {\n \"value\": \"\"\n },\n \"PKTextAlignmentRight\": {\n \"value\": \"\"\n }\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"barcodeType\": {\n \"value\": \"\"\n },\n \"descriptions\": {\n \"value\": \"\"\n },\n \"openingHours\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"oneTimeToUse\": {\n \"value\": \"\"\n },\n \"sharingProhibited\": {\n \"value\": \"\"\n },\n \"sharingProhibitedAndroid\": {\n \"value\": \"\"\n },\n \"validity\": {\n \"value\": \"\"\n },\n \"gainLabel\": {\n \"value\": \"\"\n },\n \"gainUnit\": {\n \"value\": \"\"\n },\n \"offerLabel\": {\n \"value\": \"\"\n },\n \"enableDisplayIdentifiant\": {\n \"value\": \"\"\n },\n \"gainFormatMigrated\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"displayWalletName\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"programName\": {\n \"value\": \"\"\n },\n \"keysHasChanged\": {\n \"value\": \"\"\n },\n \"startRow\": {\n \"value\": \"\"\n },\n \"middleRow\": {\n \"value\": \"\"\n },\n \"endRow\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n }\n },\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"isMultipleInstance\": {\n \"value\": \"\"\n },\n \"isWelcomeCoupon\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source\": {\n \"value\": \"\"\n },\n \"colors\": {\n \"value\": \"\"\n },\n \"valueLabel\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"promoCode\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"strip\": {\n \"value\": \"\"\n },\n \"emailSubscriptionMessage\": {\n \"value\": \"\"\n },\n \"subscriptionMessage\": {\n \"value\": \"\"\n },\n \"security\": {\n \"value\": \"\"\n },\n \"iosHeader\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1998-01-08T00:15:14.260Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1984-12-26T23:23:35.994Z\",\n \"instanceId\": {},\n \"checkin\": \"2002-04-12T21:59:49.047Z\",\n \"checkout\": \"1958-06-20T07:30:34.967Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-05-03T08:04:41.584Z\",\n \"originalExpirationDate\": \"2000-10-03T00:46:31.445Z\",\n \"admissionDate\": \"1948-04-08T20:22:41.098Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43440804-153f-4f77-bcf3-51d580a7fdc9", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3570b696-4438-49d2-be69-f2cc1b89a27b", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80cafa91-f32b-46a1-9bef-2704a7468d21", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a37a81-faa6-4f26-81d0-945dfb323055", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3300d7b0-ba38-4bf9-bd14-e6aea766e15b", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae7bfd5f-11ad-4d46-9e21-68c2fc494af4", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "transits", ":transitId", "passes", "trip", ":tripNumber", "notify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "transitId", "description": "(Required) Transit template ID (`_id`)." }, { "disabled": false, "type": "any", "value": "string", "key": "tripNumber", "description": "(Required) Trip number (`tripNumber`) of the passes to notify. By default, a pass uses the `number` of its transit template." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"Your trip has been updated. Please check your pass.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/transits/:transitId/passes/trip/:tripNumber/notify\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "952a3ea9-87b5-47ec-b695-a37c0a35b951", "name": "Hotels", "description": { "content": "Hotel booking passes.", "type": "text/plain" }, "item": [ { "id": "ecadb64e-617c-4aef-b6f1-caa8d00663cc", "name": "Create a hotel", "request": { "name": "Create a hotel", "description": { "content": "Creates a hotel, i.e. the pass template (title, colours, advantages, barcode format, address, strip image) shared by all its bookings. The request is sent as `multipart/form-data` and returns the created hotel.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "string", "type": "text", "description": "(Required) " }, { "key": "strip", "type": "file", "description": "" }, { "key": "hotelName", "value": "string", "type": "text", "description": "" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "code", "value": "string", "type": "text", "description": "" }, { "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text", "description": "" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "barcodeFormat", "value": "NONE", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "location", "value": "{\"latitude\":1261.5195255466372,\"longitude\":4269.128067905778,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "bc1f1ec9-77a0-474e-b657-b5da2b5cab93", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1978-09-29T01:24:08.936Z\",\n \"updatedAt\": \"1968-01-31T20:26:37.917Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1988-11-19T11:14:49.094Z\",\n \"updatedAt\": \"1975-12-19T05:12:27.728Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": 9341.631880444045,\n \"latitude\": 8758.870585969027,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "695730fe-a6bc-41f1-8b2e-6350c167142c", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "872a4220-6c2f-415f-b4ac-909dbffb78f1", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23b61b3d-0bfa-4779-91bc-5eb83214b212", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b03d637-809d-48b3-bd99-14bd7d959c76", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e901362-a523-4129-82b5-3d920b61d794", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "820d9ee4-ece8-4e56-a2d9-e62197fed23d", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "AZTEC", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":1255.7562169358816,\"longitude\":9244.273529459379,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b373201-05c7-4643-add3-c3c4432c9472", "name": "List hotels", "request": { "name": "List hotels", "description": { "content": "Returns the paginated list of the hotels in your wallet. Each hotel is a pass template from which you issue bookings.", "type": "text/plain" }, "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Only returns items created on or after this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "createdAtEnd", "value": "string", "description": "Only returns items created on or before this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search on `title`, `code` or the hotel ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of items per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "42009f62-773e-4309-b308-2580d6be5db2", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "createdAtEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1975-09-03T14:47:06.023Z\",\n \"updatedAt\": \"2025-09-13T15:14:43.053Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"value\": \"\"\n }\n },\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1967-10-19T14:20:06.840Z\",\n \"updatedAt\": \"1993-04-20T04:45:42.622Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"value\": \"\"\n }\n }\n ],\n \"totalDocs\": 8380.72778823167,\n \"limit\": 6715.558850038546,\n \"totalPages\": 4428.323910748286,\n \"pagingCounter\": 3494.933371455662,\n \"hasPrevPage\": false,\n \"hasNextPage\": false,\n \"page\": 372.66579868934224,\n \"prevPage\": 7691.800221217737,\n \"nextPage\": 2366.014533091605\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7847ad0b-92ca-459c-ab5b-89382cefdc14", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "createdAtEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad3f400c-8372-4726-a2a9-ebae8480b3b1", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "createdAtEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da3a1e92-6464-4cca-9f1a-0cad94b5fbe9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "createdAtEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65c07efd-639a-4ad3-bfbe-658afaad0d5b", "name": "Update a hotel", "request": { "name": "Update a hotel", "description": { "content": "Updates a hotel. Only the fields you send are changed, and the template of the passes already issued is updated accordingly. Accepts `multipart/form-data` (to change the strip image) or `application/json`.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "" }, { "key": "title", "value": "string", "type": "text", "description": "" }, { "key": "hotelName", "value": "string", "type": "text", "description": "" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "code", "value": "string", "type": "text", "description": "" }, { "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text", "description": "" }, { "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text", "description": "" }, { "key": "barcodeFormat", "value": "QR_CODE", "type": "text", "description": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)" }, { "key": "location", "value": "{\"latitude\":9875.235543046909,\"longitude\":7125.25152352846,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text", "description": "" } ] } }, "response": [ { "id": "5a6e83bf-e85b-4ad6-abc4-827b623bc790", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1978-09-29T01:24:08.936Z\",\n \"updatedAt\": \"1968-01-31T20:26:37.917Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1988-11-19T11:14:49.094Z\",\n \"updatedAt\": \"1975-12-19T05:12:27.728Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": 9341.631880444045,\n \"latitude\": 8758.870585969027,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b3585c5-a059-4656-a30b-14dd3a75b429", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c52b8455-06bd-477a-9152-e864a57d5f8d", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc45963-bd45-4988-b4a5-f28b7729e98c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c0fd56-75fc-492a-b676-876931c9cdc0", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9953a17f-afa7-43b5-9b7f-e6d8f042cefe", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "460491a7-4c36-4011-8d6b-7661c23b66cf", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5b53e69-955e-4a4e-bbce-02432eb24ccc", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "title", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "hotelName", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "code", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "advantages", "value": "[\"string\",\"string\"]", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "colors", "value": "{\"backgroundColor\":\"string\",\"labelColor\":\"string\",\"foregroundColor\":\"string\"}", "type": "text" }, { "description": { "content": " (This can only be one of AZTEC,CODE_128,PDF_417,QR_CODE,NONE)", "type": "text/plain" }, "key": "barcodeFormat", "value": "QR_CODE", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "location", "value": "{\"latitude\":3022.5401576140175,\"longitude\":7781.2370882423365,\"relevantName\":\"string\",\"relevantAddress\":\"string\"}", "type": "text" } ] } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51c5ed21-e2c9-44f5-a455-4bf5f89e5b60", "name": "Delete a hotel", "request": { "name": "Delete a hotel", "description": { "content": "Deletes a hotel and its pass template. Returns the deleted hotel.\n\n:::info[Good to know]\n\n- A hotel that still has passes cannot be deleted (`HOTEL_HAS_PASSES`): delete its passes first.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "18fce887-eb8a-4076-a0d2-c87db6bccc20", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1978-09-29T01:24:08.936Z\",\n \"updatedAt\": \"1968-01-31T20:26:37.917Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1988-11-19T11:14:49.094Z\",\n \"updatedAt\": \"1975-12-19T05:12:27.728Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": 9341.631880444045,\n \"latitude\": 8758.870585969027,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cef684eb-b0c6-44e9-bcc8-21e167a60dc2", "name": "`HOTEL_HAS_PASSES`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel has passes!\",\n \"errorCode\": \"400:HOTEL_HAS_PASSES\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfaac1be-2270-4bc5-aa05-03989c136dc8", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b9d4cc8-2dc4-433d-b145-c7a62145d2cd", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "196b130d-8f62-4ba0-bf69-574e909137ea", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "463a9e71-e600-40ff-be41-68f5898d49b5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c093735e-4dbe-408b-834a-f5e0dd8a521c", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa5cf96e-8402-4dfd-8604-c0d12c58b2d1", "name": "Get a hotel", "request": { "name": "Get a hotel", "description": { "content": "Returns the details of a hotel in your wallet from its ID.", "type": "text/plain" }, "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "05953f86-b9bb-4ca7-ad29-12191c44ab57", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"OFFER\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1978-09-29T01:24:08.936Z\",\n \"updatedAt\": \"1968-01-31T20:26:37.917Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1988-11-19T11:14:49.094Z\",\n \"updatedAt\": \"1975-12-19T05:12:27.728Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": \"string\",\n \"backgroundColor\": \"string\",\n \"foregroundColor\": \"string\"\n },\n \"barcodeFormat\": \"NONE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": 9341.631880444045,\n \"latitude\": 8758.870585969027,\n \"relevantName\": \"string\",\n \"relevantAddress\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb191027-95b5-42a2-a010-8d458e279ba0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d54b29-d19c-4173-9c97-496908a181e0", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1008331-9485-47aa-87de-75aef98dfa86", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79295a75-c5c7-4d92-a587-111e03e1eebf", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb8704f7-90aa-46fd-8afc-3757d8e01905", "name": "Create a hotel pass", "request": { "name": "Create a hotel pass", "description": { "content": "Creates a booking pass for a hotel: holder, check-in (`checkin`) and check-out (`checkout`) dates, room and benefits. Returns the created pass.\n\n:::info[Good to know]\n\n- `checkin` and `checkout` are ISO 8601 dates and `checkout` must be after `checkin`. A booking whose dates overlap another booking of the same `roomNumber` or `roomCode` in this hotel is rejected (`409:OVERLAPPING_DATES`). Without `barcode`, a value is generated; the pass is then sent to the holder according to the wallet's delivery settings.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"2003-03-07T11:18:50.758Z\",\n \"checkout\": \"2016-08-11T12:28:37.229Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"7rkqW@ioGrrTabtdXYcioIzXNWQqso.rhrc\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c7c61e4f-af3e-477c-a353-27f0c96d6d12", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5f93ae7-fd73-4e46-b848-138099cf6a0a", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "106bb7a0-a492-45c3-a492-e43efe225ea2", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ff2faa6-3a1b-4572-821a-20789c59c940", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c4f02c7-c554-4404-9b98-3ab4f8968b97", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4472595d-c837-492e-bfb4-40d33ea94946", "name": "`OVERLAPPING_DATES`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel is already reserved for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_DATES\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b1f3514-59c2-4a04-be93-73ec3354eb36", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33036846-a24a-42db-bf30-5766341a6824", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checkin\": \"1982-06-29T12:05:35.955Z\",\n \"checkout\": \"1958-06-07T22:17:21.614Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"tK-JgY@WHHCo.hnt\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "851e4355-e1ee-4b2e-b8bb-9763fc97ebd1", "name": "List the passes of a hotel", "request": { "name": "List the passes of a hotel", "description": { "content": "Returns the paginated list of the booking passes issued for a hotel, with filters on status and creation date, and a text search.\n\n:::info[Good to know]\n\n- Without `status`, passes of every status are returned, including canceled bookings (`canceled`). For a pass linked to a client, `firstName`, `lastName`, `email` and `phoneNumber` show the client's current data.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort order: `asc` or `desc`. Default: `desc`." }, { "disabled": false, "key": "createdAtStart", "value": "string", "description": "Only returns items created on or after this date (ISO 8601, inclusive)." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search on `firstName`, `lastName`, `email`, `barcode`, the pass ID or the client ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Field to sort by. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Number of items per page, from 1 to 1000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a01bcf69-4ffd-440c-af9b-8ef3d65bc558", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"coupon\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 5259.603534239949,\n \"activeAndroidDeviceCount\": 412.4312024162702,\n \"status\": \"active\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2022-11-05T21:36:55.057Z\",\n \"updatedAt\": \"2006-01-20T13:21:56.415Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1994-01-02T07:07:36.872Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1976-12-20T11:03:14.413Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2017-03-28T19:30:45.099Z\",\n \"checkout\": \"1975-01-03T20:43:58.422Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1964-04-27T02:04:42.233Z\",\n \"originalExpirationDate\": \"1972-06-24T16:05:47.020Z\",\n \"admissionDate\": \"1989-03-23T02:41:56.561Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n },\n {\n \"hotel\": {\n \"value\": \"\"\n },\n \"kind\": \"transit\",\n \"devices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"activeIOSDeviceCount\": 3915.305914564664,\n \"activeAndroidDeviceCount\": 2320.9711025644774,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1988-10-05T00:33:56.898Z\",\n \"updatedAt\": \"1989-12-18T04:08:17.633Z\",\n \"client\": {\n \"value\": \"\"\n },\n \"transit\": {\n \"value\": \"\"\n },\n \"event\": {\n \"value\": \"\"\n },\n \"storeCard\": {\n \"value\": \"\"\n },\n \"wallet\": {\n \"value\": \"\"\n },\n \"coupon\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1951-03-18T05:34:49.811Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1973-02-24T16:11:20.771Z\",\n \"instanceId\": {\n \"value\": \"\"\n },\n \"checkin\": \"2002-11-26T08:01:20.968Z\",\n \"checkout\": \"1951-06-28T09:51:12.270Z\",\n \"additionalBenefits\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1956-12-10T16:42:41.905Z\",\n \"originalExpirationDate\": \"2021-10-10T15:15:42.145Z\",\n \"admissionDate\": \"1958-11-20T16:45:16.573Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n }\n ],\n \"totalDocs\": 7094.688490914853,\n \"limit\": 9803.637664981445,\n \"totalPages\": 7342.415573570176,\n \"pagingCounter\": 302.93203536782,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 7181.0562155666275,\n \"prevPage\": 3881.3622460758834,\n \"nextPage\": 423.2881817674583\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bb07578-f7d1-4229-b3c6-95a708576448", "name": "`INVALID_PASS_KIND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invalid pass kind\",\n \"errorCode\": \"400:INVALID_PASS_KIND\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314fd2aa-d444-495c-8fd9-907d86a5598a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b55ad3e-001c-40c7-8573-458101ff21a2", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f08c72c-8ed6-467c-99ac-54468907e56e", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81a44e0a-1d2c-45a6-b12c-85d7f34045ae", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "createdAtStart", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "278915a8-e92d-4d12-a429-96270e40f804", "name": "Get a hotel pass", "request": { "name": "Get a hotel pass", "description": { "content": "Returns a booking pass from its ID.\n\n:::info[Good to know]\n\n- The pass must belong to this hotel and to your wallet, otherwise `MODEL_NOT_FOUND` is returned.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f8271d2c-57cb-4c94-8da6-da4c413c9447", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25dbadc2-889e-4ce7-9a83-c1c21956b06e", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e4e3a9b-6d1f-4fcd-8bd8-fe54fa19ae1d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b6968c9-a42b-44cb-8a5a-f01f40dff21c", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23061e34-d2a0-41b6-982f-ddd261b08a3c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6784d18-2bf4-47fd-903f-ede6165d7555", "name": "Update a hotel pass", "request": { "name": "Update a hotel pass", "description": { "content": "Updates a booking (dates, room, holder, status) and pushes the change to the installed pass. Set `status` to `canceled` to cancel the booking.\n\n:::info[Good to know]\n\n- A canceled booking can no longer be updated (`PASS_ALREADY_CANCELED`); setting `status` to `canceled` also expires the pass. New dates must keep `checkout` after `checkin` (`CHECKOUT_MUST_BE_AFTER_CHECKIN`) and must not overlap another booking of the same room (`409:OVERLAPPING_DATES`).\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"inactive\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"3Ul1fYNZVe@QtPZFTHhTdDnmhRyIy.czn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2023-04-28T08:35:38.993Z\",\n \"checkout\": \"1994-03-07T06:41:54.659Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56a34a54-b8be-45e8-b3a1-57c4644defb2", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8cac473-6f60-41f5-8f22-546239d4dae0", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `PASS_ALREADY_CANCELED` · `CHECKOUT_MUST_BE_AFTER_CHECKIN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d753c52-f867-4b17-b75c-f0a03bc74b5e", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "820ce7c4-13a1-4fbd-a6da-61dc9abcf40a", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29b69248-9af9-4318-b2ff-d0d4be012432", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6f6d315-22d4-41a6-908e-59cba542d177", "name": "`OVERLAPPING_DATES`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel is already reserved for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_DATES\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ca8741-caa2-41d2-9f8a-48b7079bc7dc", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8842fe-5902-4c78-95ff-9042b93b03ec", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"6EOnkSnaKj@aRelWpWbulHGnIZQtsdUhQeqKAw.ejn\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"2012-05-14T14:18:14.879Z\",\n \"checkout\": \"1975-09-29T10:55:05.686Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0cb88403-6a04-4cb8-bb0d-088df42c7341", "name": "Delete a hotel pass", "request": { "name": "Delete a hotel pass", "description": { "content": "Permanently deletes a booking pass. Returns the deleted pass.\n\n:::info[Good to know]\n\n- Deletion is permanent. To keep a trace of the booking, cancel it instead with `PATCH /hotels/{id}/passes/{passId}` and `status: canceled`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "252b5218-df06-416d-96cb-f8cef60c8c95", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3806e2d-4063-42d2-8bef-b0591d1ceaa3", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d24bc6c-17f3-4331-a783-d57eca4cbb62", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "787ccf5a-416b-4699-b1a5-56b46336cdc8", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0852b47-165d-4b5e-90ea-70ade60b416c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4ec64a8-255d-4b28-8cba-bdbff44b31e3", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", ":passId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." }, { "disabled": false, "type": "any", "value": "string", "key": "passId", "description": "(Required) Hotel pass ID (MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/hotels/:id/passes/:passId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f01f4f54-0aa4-4441-867b-74e2e7dbe5b6", "name": "Bulk create hotel passes", "request": { "name": "Bulk create hotel passes", "description": { "content": "Processed asynchronously. Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Each item follows the rules of `POST /hotels/{id}/passes` (`checkin` before `checkout`, no overlapping booking on the same room). Up to 5,000 items; `forceSync: true` runs the operation synchronously and is limited to fewer than 1,000 items (`SYNC_EXECUTION_NOT_ALLOWED`). `webhookUrl` is called when the operation completes.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c1b131e6-fc73-46d1-a21d-bf82d481fe70", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8c52fc3-fa7b-429d-ad10-3bedfdbd49fc", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "239de9dd-711c-4f29-9b5c-9dc303530441", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65293b7-3342-4af7-b8d4-660cea9b84e7", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50ac7a3f-fa71-4cc0-8652-d0ef6e0ce3fa", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74cf4d0f-2667-46ec-9e19-7bdd5266ccdd", "name": "`OVERLAPPING_DATES`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel is already reserved for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_DATES\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a5eac17-5b38-4a3f-8f2d-9588b7618cab", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"checkin\": \"1948-07-11T11:28:47.937Z\",\n \"checkout\": \"2007-02-07T15:07:21.365Z\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"HsBG6VfgkLq@NDFS.ecq\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f7349d4-bf53-4696-af1a-91d156e53187", "name": "Bulk update hotel passes", "request": { "name": "Bulk update hotel passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Each item carries the `passId` to update plus the fields to change, with the same rules as `PATCH /hotels/{id}/passes/{passId}` (canceled bookings cannot be updated). Up to 5,000 items; `forceSync: true` is limited to fewer than 1,000 items.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"inactive\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"pNwgCw@nGgJjENsDXQvipbVyCIzYXM.pvqf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1985-08-04T17:47:12.848Z\",\n \"checkout\": \"1957-12-24T18:18:14.302Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96a7269d-59b8-4c14-bdc1-7c8d533780a8", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab455eb8-bfa6-4998-badd-397be5d4d036", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `PASS_ALREADY_CANCELED` · `CHECKOUT_MUST_BE_AFTER_CHECKIN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10ad542d-36af-4e2d-9ddf-509389b266ae", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e465ef88-70b1-4862-80ac-9e9727d0875a", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0289ef0d-24b4-4e99-9dc3-e14a68140697", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c68df2e-1c32-4a2d-ab01-a6c74f4d1614", "name": "`OVERLAPPING_DATES`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Hotel is already reserved for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_DATES\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc49d45a-aa9a-4e12-a840-77cc66448f89", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"passId\": \"507f1f77bcf86cd799439011\",\n \"status\": \"deleted\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"rGOOPUpLBzmKm9@qNdAbjLOxAQYDCmsiuIaJs.mkf\",\n \"phoneNumber\": \"string\",\n \"barcode\": \"string\",\n \"checkin\": \"1984-02-24T04:35:23.974Z\",\n \"checkout\": \"1975-05-03T08:15:17.583Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\"\n }\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f09c6900-9b3b-4f37-a3a3-a2dccc41cb7a", "name": "Bulk delete hotel passes", "request": { "name": "Bulk delete hotel passes", "description": { "content": "Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.\n\n:::info[Good to know]\n\n- Send the IDs of the passes to delete in `passIds` (not `ids`); each pass must belong to this hotel. Deletion is permanent.\n\n:::", "type": "text/plain" }, "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "811304e5-a715-4936-a067-2d613852efb2", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a950ee1-0b4c-4c7c-8dd7-40336b58ec12", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a8e2200-b8bd-43af-a101-a47977ef72ea", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f939120-2e55-48bc-b75e-608373e346c8", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75a4ba57-befd-4cdd-ba40-80177a411458", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52d93b9e-fc07-415f-a491-ca399d90dcf7", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "hotels", ":id", "passes", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Hotel ID (24-character hexadecimal MongoDB ID)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"passIds\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439012\"\n ],\n \"webhookUrl\": \"https://example.com/webhook#headers=Authorization:Bearer%20token\",\n \"forceSync\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/hotels/:id/passes/bulk\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "36fcc3e3-a733-438e-bd8f-40a3b779c192", "name": "Passes", "description": { "content": "Redeem a pass or undo a redemption.", "type": "text/plain" }, "item": [ { "id": "b38bdb41-145d-45e7-866e-279ce0f68a59", "name": "Redeem a pass", "request": { "name": "Redeem a pass", "description": { "content": "Marks the pass as used. Returns `PASS_ALREADY_REDEEMED` if the pass has already been redeemed.\n\n:::info[Good to know]\n\n- Works for any template type (coupon, event, transit, hotel, store card). On the pass, the barcode is replaced by the text « utilisé ». No push notification is sent to the holder; for a coupon, `PUT /coupons/{id}/passes/{instanceId}/status` with `USED` does send one.\n\n:::", "type": "text/plain" }, "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "d93256fe-8101-47f1-a7b0-9505bf0e42f1", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1992-11-27T09:27:18.885Z\",\n \"updatedAt\": \"2024-10-15T19:58:13.953Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"AZTEC\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"storeCard\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1974-08-12T18:50:50.885Z\",\n \"isDeleted\": false\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1989-09-07T10:50:15.693Z\",\n \"isDeleted\": true\n }\n ],\n \"activeIOSDeviceCount\": 5799.742622131914,\n \"activeAndroidDeviceCount\": 261.5064847936921,\n \"status\": \"canceled\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1981-08-28T10:24:38.274Z\",\n \"updatedAt\": \"2011-02-23T17:51:15.055Z\",\n \"client\": {\n \"source\": \"CRM\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1979-03-17T02:30:05.351Z\",\n \"updatedAt\": \"1961-12-05T03:11:25.121Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1982-03-30T00:08:31.158Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1976-07-20T05:59:53.411Z\",\n \"admissionDate\": \"2015-05-25T18:24:26.361Z\",\n \"gain\": 5486.479569313627,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Boat\",\n \"_id\": \"string\",\n \"createdAt\": \"1994-10-27T00:52:06.146Z\",\n \"updatedAt\": \"2019-05-02T18:03:59.680Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"N_CABINE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"PDF_417\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1990-05-11T07:53:39.656Z\",\n \"updatedAt\": \"2002-09-22T10:22:43.012Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 7792.181148518733,\n \"gainUnit\": \"MAD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"CHAIR\",\n \"PKTextAlignmentCenter\": \"ROW\",\n \"PKTextAlignmentRight\": \"TYPE\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"STORE_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"PDF_417\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"POINTS\",\n \"gainUnit\": \"USD\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1993-03-05T01:16:22.630Z\",\n \"updatedAt\": \"1968-06-28T05:54:56.114Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"GAIN\",\n \"middleRow\": \"CLUB\",\n \"endRow\": \"ASSOCIATION\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"TRANSIT\",\n \"EVENT_TICKET\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1958-01-16T21:04:18.891Z\",\n \"updatedAt\": \"1991-07-20T16:56:46.438Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"CODE_128\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": false,\n \"isWelcomeCoupon\": false,\n \"status\": \"ACTIVE\",\n \"source\": \"ALL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1952-04-02T20:03:41.227Z\",\n \"updatedAt\": \"1988-11-29T05:01:45.719Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1957-12-04T22:53:43.156Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"1965-07-28T03:53:56.633Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1962-07-25T01:45:36.704Z\",\n \"instanceId\": {},\n \"checkin\": \"2001-04-13T04:13:13.155Z\",\n \"checkout\": \"1976-12-26T19:38:09.424Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1979-01-19T08:56:50.303Z\",\n \"originalExpirationDate\": \"1952-03-24T12:30:07.726Z\",\n \"admissionDate\": \"1989-11-17T14:11:28.462Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc211f92-da4c-40ae-a9d5-0187a7cd2735", "name": "`PASS_ALREADY_REDEEMED`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Pass is already redeemed\",\n \"errorCode\": \"400:PASS_ALREADY_REDEEMED\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb0fdb4f-d064-448c-a102-247c539a35eb", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83dac23-a071-44ff-ad8c-c8a49a696e53", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b5f4bfc-ec8e-4065-8b2e-2880f4233e1b", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5abe40ce-6e05-4054-a1e8-ced0efd713c5", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cdfd8c8-17a3-445d-97bd-6a252d858580", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "redeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass to redeem." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/passes/template/:templateId/redeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9517a385-c832-4080-b309-06d7dab4d1ea", "name": "Unredeem a pass", "request": { "name": "Unredeem a pass", "description": { "content": "Reverts the redemption of the pass. Returns `PASS_NOT_REDEEMED` if the pass has not been redeemed.\n\n:::info[Good to know]\n\n- Restores the original barcode on the pass. No push notification is sent, and the pass status and expiration date are not changed.\n\n:::", "type": "text/plain" }, "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "d7abcc97-2f9e-4f51-9052-e85bdbdea5e1", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"hotel\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"title\": \"string\",\n \"advantages\": [\n \"string\",\n \"string\"\n ],\n \"_id\": \"string\",\n \"createdAt\": \"2006-10-22T15:43:05.238Z\",\n \"updatedAt\": \"2007-04-21T22:08:13.181Z\",\n \"hotelName\": \"string\",\n \"description\": \"string\",\n \"strip\": \"string\",\n \"code\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"barcodeFormat\": \"QR_CODE\",\n \"passBuilderPassTemplateId\": \"string\",\n \"location\": {\n \"longitude\": {\n \"value\": \"\"\n },\n \"latitude\": {\n \"value\": \"\"\n },\n \"relevantName\": {\n \"value\": \"\"\n },\n \"relevantAddress\": {\n \"value\": \"\"\n }\n }\n },\n \"kind\": \"event\",\n \"devices\": [\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"ANDROID\",\n \"registeredAt\": \"1998-05-16T03:40:17.784Z\",\n \"isDeleted\": true\n },\n {\n \"deviceLibraryIdentifier\": \"string\",\n \"deviceType\": \"IOS\",\n \"registeredAt\": \"2014-12-24T14:55:50.082Z\",\n \"isDeleted\": false\n }\n ],\n \"activeIOSDeviceCount\": 4428.369644794639,\n \"activeAndroidDeviceCount\": 5764.311558973676,\n \"status\": \"expired\",\n \"instanceLinks\": [\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n },\n {\n \"instanceId\": \"string\",\n \"link\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n ],\n \"departureDate\": \"string\",\n \"arrivalDate\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"1970-07-02T14:57:16.003Z\",\n \"updatedAt\": \"1970-09-23T07:07:55.440Z\",\n \"client\": {\n \"source\": \"INTERNAL\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"_id\": \"string\",\n \"createdAt\": \"2005-05-01T07:53:57.127Z\",\n \"updatedAt\": \"2018-05-01T05:51:57.972Z\",\n \"wallet\": \"string\",\n \"clientType\": {\n \"value\": \"\"\n },\n \"barcode\": \"string\",\n \"email\": \"string\",\n \"companyName\": \"string\",\n \"renewalDate\": \"1984-11-22T17:33:37.296Z\",\n \"phoneNumber\": \"string\",\n \"birthDate\": \"1957-09-23T18:55:27.626Z\",\n \"admissionDate\": \"1972-03-01T05:37:43.485Z\",\n \"gain\": 3396.968551559345,\n \"gainHistory\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"communicationPreferences\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pushInformativeEnabled\": false,\n \"pushCommercialEnabled\": true\n },\n \"transit\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"PDF_417\",\n \"terms\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"originStationCode\": \"string\",\n \"originName\": \"string\",\n \"destinationStationCode\": \"string\",\n \"destinationName\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"details\": \"string\",\n \"number\": \"string\",\n \"type\": \"Generic\",\n \"_id\": \"string\",\n \"createdAt\": \"1976-07-13T21:31:38.582Z\",\n \"updatedAt\": \"2013-05-24T03:52:06.539Z\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"strip\": \"string\",\n \"customerServiceNumber\": \"string\",\n \"tarif\": \"string\",\n \"gateName\": \"N_CABINE\",\n \"seatName\": \"PLAQUE\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"displayOptions\": {\n \"hideTarif\": {\n \"value\": \"\"\n },\n \"hideStationCodes\": {\n \"value\": \"\"\n },\n \"hideTripNumber\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"event\": {\n \"status\": \"PENDING\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeType\": \"QR_CODE\",\n \"name\": \"string\",\n \"locations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"subscriptionMessage\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"_id\": \"string\",\n \"createdAt\": \"1972-07-23T10:09:33.939Z\",\n \"updatedAt\": \"1974-08-15T01:18:23.564Z\",\n \"date\": {\n \"startDate\": {\n \"value\": \"\"\n },\n \"endDate\": {\n \"value\": \"\"\n },\n \"doorOpeningHour\": {\n \"value\": \"\"\n }\n },\n \"price\": 929.3320685037431,\n \"gainUnit\": \"USD\",\n \"description\": \"string\",\n \"terms\": \"string\",\n \"contactPhone\": \"string\",\n \"email\": \"string\",\n \"website\": \"string\",\n \"security\": {\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"disablePassLinkSharing\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\",\n \"strip\": \"string\",\n \"PKTextAlignmentLeft\": \"INACTIVE\",\n \"PKTextAlignmentCenter\": \"INACTIVE\",\n \"PKTextAlignmentRight\": \"SEAT\"\n },\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"CODE_128\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": true,\n \"sharingProhibitedAndroid\": false,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"NONE\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": true,\n \"gainFormatMigrated\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2002-05-31T10:41:52.367Z\",\n \"updatedAt\": \"2015-05-03T03:40:16.113Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"N_LICENCE\",\n \"middleRow\": \"ASSOCIATION\",\n \"endRow\": \"GAIN\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"EVENT_TICKET\",\n \"ALL\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2001-03-22T13:06:05.264Z\",\n \"updatedAt\": \"1985-05-13T18:42:09.049Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"coupon\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"barcodeFormat\": \"NONE\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"isMultipleInstance\": true,\n \"isWelcomeCoupon\": true,\n \"status\": \"INACTIVE\",\n \"source\": \"EXTERNAL\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"valueLabel\": \"AMOUNT\",\n \"_id\": \"string\",\n \"createdAt\": \"1977-10-02T22:05:02.211Z\",\n \"updatedAt\": \"1976-08-30T01:01:23.291Z\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"expirationDate\": \"1979-12-10T06:50:38.500Z\",\n \"strip\": \"string\",\n \"emailSubscriptionMessage\": \"string\",\n \"subscriptionMessage\": \"string\",\n \"security\": {\n \"oneTimeToUseJwtLink\": {\n \"value\": \"\"\n },\n \"disableIOSPassSharing\": {\n \"value\": \"\"\n },\n \"enableOneTimeUse\": {\n \"value\": \"\"\n },\n \"disableMultipleHolders\": {\n \"value\": \"\"\n },\n \"enableSecurityAnimation\": {\n \"value\": \"\"\n },\n \"enableRotatingBarcode\": {\n \"value\": \"\"\n }\n },\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n },\n \"passBuilderPassTemplateId\": \"string\"\n },\n \"passBuilderPassId\": \"string\",\n \"passBuilderUpdatedAt\": \"2000-03-11T08:59:36.162Z\",\n \"shortId\": \"string\",\n \"legacyShortId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"barcode\": \"string\",\n \"phoneNumber\": \"string\",\n \"redeemedAt\": \"1960-07-24T03:59:06.424Z\",\n \"instanceId\": {},\n \"checkin\": \"1992-04-20T12:51:31.294Z\",\n \"checkout\": \"1995-06-18T13:36:26.762Z\",\n \"additionalBenefits\": [\n \"string\",\n \"string\"\n ],\n \"roomNumber\": \"string\",\n \"roomCode\": \"string\",\n \"gate\": \"string\",\n \"seat\": \"string\",\n \"originName\": \"string\",\n \"destinationName\": \"string\",\n \"originStationCode\": \"string\",\n \"destinationStationCode\": \"string\",\n \"departureTime\": \"string\",\n \"arrivalTime\": \"string\",\n \"tarif\": \"string\",\n \"tripNumber\": \"string\",\n \"expirationDate\": \"1949-04-24T08:56:52.529Z\",\n \"originalExpirationDate\": \"2005-09-17T08:19:49.304Z\",\n \"admissionDate\": \"1967-02-09T04:25:17.362Z\",\n \"backFieldName\": \"string\",\n \"backFieldContent\": \"string\",\n \"customBackFields\": [\n \"string\",\n \"string\"\n ],\n \"leftRow\": \"string\",\n \"centerRow\": \"string\",\n \"rightRow\": \"string\",\n \"promoCode\": \"string\",\n \"value\": \"string\",\n \"unit\": \"string\",\n \"description\": \"string\",\n \"bannerOverrideUrl\": \"string\",\n \"downloadedVia\": {},\n \"shortLink\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a200e5ad-feb6-4dd2-9a55-17e70284f82b", "name": "`PASS_NOT_REDEEMED`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Pass is not redeemed\",\n \"errorCode\": \"400:PASS_NOT_REDEEMED\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74fa3a6e-f2f8-476d-a299-1cd7578fb04c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd3d958a-d771-4b66-bf6f-f3d05244df6d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4aaf299-8fb6-4aaa-b2a9-4436e293f6fc", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b1eade1-9749-4660-8c88-9618c5f5726c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26fca3a3-b772-4885-a9f5-6c625218fc72", "name": "`PASS_BUILDER_ERROR`", "originalRequest": { "url": { "path": [ "passes", "template", ":templateId", "unredeem", ":barcode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "templateId", "description": "(Required) ID of the template the pass belongs to (coupon, event, transit, hotel or store card)." }, { "disabled": false, "type": "any", "value": "string", "key": "barcode", "description": "(Required) Exact barcode value of the pass whose redemption is reverted." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"External service error\",\n \"errorCode\": \"503:PASS_BUILDER_ERROR\",\n \"path\": \"/passes/template/:templateId/unredeem/:barcode\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e4322fd0-dcc7-45c1-b579-27215435d40b", "name": "Communications", "description": { "content": "Messages shown on the back of passes and notified to holders.", "type": "text/plain" }, "item": [ { "id": "bdf62a83-e787-411a-a63e-392ad8d3ec7d", "name": "Create a communication", "request": { "name": "Create a communication", "description": { "content": "Creates a communication (offer) shown on the loyalty card of every holder in the wallet: a `strip` image replaces the card's banner and the `description` is added to the back. It goes live right away with `instant: true`, otherwise at `startDate`, and runs until `endDate`, or with no end with `unlimited: true`. Returns the created communication.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `startDate` is required when `instant` is missing or `false`.\n- `endDate` is required when `unlimited` is missing or `false`.\n- Only one communication can be live at a time: a period that overlaps a `PENDING` or `ACTIVE` one returns `409:OVERLAPPING_COMMUNICATIONS`, and a second `unlimited` one returns `UNLIMITED_COMMUNICATION_ALREADY_EXISTS`. Holders of an active loyalty card are notified by push, email and SMS according to the wallet's communication rules and each client's preferences; credit is checked per channel before anything is created: `INSUFFICIENT_CREDIT` when no channel can cover every client, `409:INSUFFICIENT_CREDIT_PARTIAL` when only some can, unless you send `acceptPartialDelivery: true` to notify on the funded channels only. The card goes back to its original image and loses the back field when the communication ends.\n\n:::", "type": "text/plain" }, "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "strip", "type": "file", "description": "(Required) " }, { "key": "description", "value": "string", "type": "text", "description": "(Required) " }, { "key": "instant", "value": "true", "type": "text", "description": "" }, { "key": "unlimited", "value": "false", "type": "text", "description": "" }, { "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text", "description": "" }, { "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text", "description": "" }, { "key": "minPoints", "value": "68.22701947998944", "type": "text", "description": "" }, { "key": "maxPoints", "value": "3607.888915532835", "type": "text", "description": "" } ] } }, "response": [ { "id": "43c81915-db73-4bf3-bbe4-8b5e40741328", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"strip\": \"string\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"BOARDING_PASS\",\n \"COUPON\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1953-08-03T00:05:00.197Z\",\n \"updatedAt\": \"2006-05-05T18:55:21.468Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": false,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1983-03-08T13:56:48.482Z\",\n \"updatedAt\": \"1968-05-27T16:37:33.393Z\",\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": true,\n \"strip\": \"string\",\n \"barcodeType\": \"NONE\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": true,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"GAINS\",\n \"gainUnit\": \"EURO\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1951-09-28T12:59:24.396Z\",\n \"updatedAt\": \"1993-04-19T09:49:53.220Z\",\n \"displayWalletName\": true,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"EXPIRATION_DATE\",\n \"middleRow\": \"MEMBER\",\n \"endRow\": \"N_MEMBER\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"startDate\": \"1993-05-24T09:09:05.725Z\",\n \"endDate\": \"2014-05-02T18:03:24.510Z\",\n \"minPoints\": 9611.934703495017,\n \"maxPoints\": 4933.111224405599\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae2ecd1e-247b-4b94-a3c8-b7246b89b353", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART` · `UNLIMITED_COMMUNICATION_ALREADY_EXISTS` · `INSUFFICIENT_CREDIT`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98c7d50-a275-4981-b646-1f0ae39e49f3", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8323d9f-f27f-4280-b5bd-8de2c15349e8", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71013cc2-6fb0-483a-9f3d-4e0f412a61dd", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52c980ac-d892-4339-84d2-7b22a0ca9149", "name": "`OVERLAPPING_COMMUNICATIONS` · `INSUFFICIENT_CREDIT_PARTIAL`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Overlapping communications exist for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_COMMUNICATIONS\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "269129ca-d5a3-439f-ba72-c0bb466d5627", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56f6bef4-3587-4040-aa41-3972c923bae7", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1951-03-06T07:03:52.195Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "1980-04-23T20:41:22.061Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "68.22701947998944", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "3607.888915532835", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d96f5d4-81db-4e6c-bff0-78dc47f31dfd", "name": "List communications", "request": { "name": "List communications", "description": { "content": "Paginated list of the wallet's communications, filterable by status, by start-date range and by a text search on the description.\n\n:::info[Good to know]\n\n- Statuses: `PENDING` (waiting for `startDate`), `ACTIVE` (live on the loyalty card), `INACTIF` (deactivated), `EXPIRED` (`endDate` passed). Activation at `startDate` and expiry at `endDate` are handled automatically.\n\n:::", "type": "text/plain" }, "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort direction: `ASC` or `DESC`. Default: `DESC`." }, { "disabled": false, "key": "status", "value": "ACTIVE", "description": "Filter by status: `PENDING`, `ACTIVE`, `INACTIF` or `EXPIRED`." }, { "disabled": false, "key": "startDateStart", "value": "string", "description": "Only return communications whose `startDate` is on or after this date (ISO 8601)." }, { "disabled": false, "key": "startDateEnd", "value": "string", "description": "Only return communications whose `startDate` is on or before this date (ISO 8601)." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search in the communication's `description` or ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Items per page, from 1 to 1,000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "41fa73ed-761f-48c6-acba-87a46b43741d", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "ACTIVE" }, { "key": "startDateStart", "value": "string" }, { "key": "startDateEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"strip\": \"string\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": false,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1995-12-02T09:32:43.385Z\",\n \"updatedAt\": \"1987-02-25T02:48:04.290Z\",\n \"storeCard\": {\n \"value\": \"\"\n },\n \"startDate\": \"2014-02-10T05:28:50.194Z\",\n \"endDate\": \"1962-12-24T19:11:33.714Z\",\n \"minPoints\": 2435.3291278640168,\n \"maxPoints\": 9726.306530036278\n },\n {\n \"strip\": \"string\",\n \"wallet\": {\n \"value\": \"\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": true,\n \"unlimited\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1998-12-03T04:41:52.320Z\",\n \"updatedAt\": \"1954-07-06T20:32:38.673Z\",\n \"storeCard\": {\n \"value\": \"\"\n },\n \"startDate\": \"1988-07-25T10:20:08.162Z\",\n \"endDate\": \"1994-09-13T00:33:34.435Z\",\n \"minPoints\": 4811.028300209968,\n \"maxPoints\": 6223.464255756759\n }\n ],\n \"totalDocs\": 9053.074098734178,\n \"limit\": 3705.8924686022588,\n \"totalPages\": 8406.714590404123,\n \"pagingCounter\": 1974.1566936312993,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"page\": 9534.382740809222,\n \"prevPage\": 6162.530615266648,\n \"nextPage\": 9982.595979229498\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "575b1c31-7d23-4e93-9ff2-335da514a1be", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "ACTIVE" }, { "key": "startDateStart", "value": "string" }, { "key": "startDateEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f990195-d847-4680-afd2-5be1329bee54", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "ACTIVE" }, { "key": "startDateStart", "value": "string" }, { "key": "startDateEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e307be0-869b-4b5f-b465-517e1a2a747b", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "status", "value": "ACTIVE" }, { "key": "startDateStart", "value": "string" }, { "key": "startDateEnd", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d152ed8-11f5-4141-813c-a0a080fce75c", "name": "Update a communication", "request": { "name": "Update a communication", "description": { "content": "Updates a communication: text, image, dates or status (`EXPIRED` is not accepted). If the communication is live, the card is updated and holders are notified. Returns the updated communication.\n\n:::info[Good to know]\n\n- Body is `multipart/form-data`: nested objects (`colors`, `security`, `locations`…) are sent as a **JSON string**, booleans as `\"true\"`/`\"false\"`. Images: PNG or JPEG, 1 KB to 5 MB.\n- `startDate` is required when `instant` is missing or `false`.\n- `endDate` is required when `unlimited` is missing or `false`.\n- The card update and the notifications run in the background after the response. Editing a communication that is already `ACTIVE` notifies holders again without consuming credit. An `ACTIVE` communication whose resulting `startDate` is in the future goes back to `PENDING`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "key": "status", "value": "PENDING", "type": "text", "description": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)" }, { "key": "strip", "type": "file", "description": "" }, { "key": "instant", "value": "false", "type": "text", "description": "" }, { "key": "unlimited", "value": "true", "type": "text", "description": "" }, { "key": "description", "value": "string", "type": "text", "description": "" }, { "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text", "description": "" }, { "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text", "description": "" }, { "key": "minPoints", "value": "6240.204655770321", "type": "text", "description": "" }, { "key": "maxPoints", "value": "1305.8034040222788", "type": "text", "description": "" } ] } }, "response": [ { "id": "d5551c04-e7d1-462a-84f9-50a680eae751", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"strip\": \"string\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"TRANSIT\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2007-05-22T09:51:33.586Z\",\n \"updatedAt\": \"1952-09-26T20:38:33.808Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": true,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2020-08-23T05:06:45.088Z\",\n \"updatedAt\": \"1976-06-02T16:25:50.344Z\",\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"POINTS\",\n \"gainUnit\": \"POINTS\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1964-09-29T13:43:43.609Z\",\n \"updatedAt\": \"1992-01-10T20:58:47.771Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"GAIN\",\n \"middleRow\": \"EXPIRATION_DATE\",\n \"endRow\": \"N_ADHERENT\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"startDate\": \"1974-12-29T20:13:01.108Z\",\n \"endDate\": \"1951-01-18T04:18:55.664Z\",\n \"minPoints\": 6248.077602084439,\n \"maxPoints\": 4775.705157207115\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7325045a-5bc3-4e29-8353-a5125872723f", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INVALID_MULTIPART`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f005a2bf-2a33-4dca-8a1a-fd9e87b91e6b", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766684b4-5190-4502-9e62-a69c826ae36d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cc1e1c2-d545-4863-8dbf-847c05bfd8a7", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b20e0447-0512-4390-b962-f447fecbb9cf", "name": "`OVERLAPPING_COMMUNICATIONS`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Overlapping communications exist for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_COMMUNICATIONS\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "014918ee-eef6-4485-83ea-04ed44c3913e", "name": "`UNSUPPORTED_MEDIA_TYPE`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unsupported Content-Type. Use application/json or multipart/form-data.\",\n \"errorCode\": \"415:UNSUPPORTED_MEDIA_TYPE\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54906884-73ab-477a-8c6a-65afa2edae86", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) (This can only be one of PENDING,ACTIVE,INACTIF,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "PENDING", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "strip", "type": "file" }, { "description": { "content": "", "type": "text/plain" }, "key": "instant", "value": "false", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "unlimited", "value": "true", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "description", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "startDate", "value": "1964-08-08T19:13:03.947Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "endDate", "value": "2015-07-25T19:17:33.926Z", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "minPoints", "value": "6240.204655770321", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "maxPoints", "value": "1305.8034040222788", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ac3904e-b592-48da-8d5f-0c798a1bc5b6", "name": "Delete a communication", "request": { "name": "Delete a communication", "description": { "content": "Permanently deletes a communication. If it was live (`ACTIVE`), the loyalty card gets its original image back and holders are notified that the offer has ended. Returns the deleted communication.", "type": "text/plain" }, "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "e8da5e8f-2ad2-4be6-9be8-09a16ab0fd29", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"strip\": \"string\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"TRANSIT\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2007-05-22T09:51:33.586Z\",\n \"updatedAt\": \"1952-09-26T20:38:33.808Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": true,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2020-08-23T05:06:45.088Z\",\n \"updatedAt\": \"1976-06-02T16:25:50.344Z\",\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"POINTS\",\n \"gainUnit\": \"POINTS\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1964-09-29T13:43:43.609Z\",\n \"updatedAt\": \"1992-01-10T20:58:47.771Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"GAIN\",\n \"middleRow\": \"EXPIRATION_DATE\",\n \"endRow\": \"N_ADHERENT\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"startDate\": \"1974-12-29T20:13:01.108Z\",\n \"endDate\": \"1951-01-18T04:18:55.664Z\",\n \"minPoints\": 6248.077602084439,\n \"maxPoints\": 4775.705157207115\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89bfd55e-740e-4fe6-90aa-684a26ba3afc", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d4647b-0928-495d-9eaf-8b9ef09752f8", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c4b990-92c1-4141-ac06-d0f7f44903d6", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f363d1f-98c1-47fc-b131-462b30526202", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c600b905-b14e-460b-9f52-56495f9c5860", "name": "Get a communication", "request": { "name": "Get a communication", "description": { "content": "Returns a communication by ID, with its status, dates and the key of its `strip` image.", "type": "text/plain" }, "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "730166d9-39ff-4b74-9eb2-4f321ae1fc72", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"strip\": \"string\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"TRANSIT\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2007-05-22T09:51:33.586Z\",\n \"updatedAt\": \"1952-09-26T20:38:33.808Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": true,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2020-08-23T05:06:45.088Z\",\n \"updatedAt\": \"1976-06-02T16:25:50.344Z\",\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"POINTS\",\n \"gainUnit\": \"POINTS\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1964-09-29T13:43:43.609Z\",\n \"updatedAt\": \"1992-01-10T20:58:47.771Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"GAIN\",\n \"middleRow\": \"EXPIRATION_DATE\",\n \"endRow\": \"N_ADHERENT\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"startDate\": \"1974-12-29T20:13:01.108Z\",\n \"endDate\": \"1951-01-18T04:18:55.664Z\",\n \"minPoints\": 6248.077602084439,\n \"maxPoints\": 4775.705157207115\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86682b18-c8d4-46db-bbea-fdf4d7d2bfbf", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9653ed8d-135a-44cf-988a-ca69aaed49bf", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf251e2-6d2b-4b30-82c7-0142a2a25741", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8a9b6d7-67f5-4d94-8bd0-dd07e2bf09fa", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc4c30a4-63fb-46af-8092-f873ddaf65ee", "name": "Activate or deactivate a communication", "request": { "name": "Activate or deactivate a communication", "description": { "content": "Activates (`ACTIF`) or deactivates (`INACTIF`) a communication without changing its content. Activating puts it live on the loyalty card; deactivating a live communication restores the card's original image.\n\n:::info[Good to know]\n\n- `ACTIF` puts the communication live immediately, whatever its `startDate`, after checking for overlaps (`409:OVERLAPPING_COMMUNICATIONS`). `INACTIF` on a live communication notifies holders that the offer has ended. The response returns the communication as it was before the status change: read it again to get the new `status`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ee668467-3933-429d-89db-e53c5d214149", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"strip\": \"string\",\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"TRANSIT\",\n \"CINEMA\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2007-05-22T09:51:33.586Z\",\n \"updatedAt\": \"1952-09-26T20:38:33.808Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"description\": \"string\",\n \"status\": \"PENDING\",\n \"instant\": true,\n \"unlimited\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2020-08-23T05:06:45.088Z\",\n \"updatedAt\": \"1976-06-02T16:25:50.344Z\",\n \"storeCard\": {\n \"wallet\": {\n \"value\": \"\"\n },\n \"cardType\": \"MEMBER_CARD\",\n \"displayIdentifiant\": false,\n \"strip\": \"string\",\n \"barcodeType\": \"AZTEC\",\n \"descriptions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"openingHours\": \"string\",\n \"colors\": {\n \"labelColor\": {\n \"value\": \"\"\n },\n \"backgroundColor\": {\n \"value\": \"\"\n },\n \"foregroundColor\": {\n \"value\": \"\"\n }\n },\n \"oneTimeToUse\": false,\n \"sharingProhibited\": false,\n \"sharingProhibitedAndroid\": true,\n \"validity\": {\n \"expirationType\": {\n \"value\": \"\"\n },\n \"expirationDate\": {\n \"value\": \"\"\n },\n \"expirationAfterPeriod\": {\n \"value\": \"\"\n },\n \"expirationPeriodType\": {\n \"value\": \"\"\n },\n \"expirationOption\": {\n \"value\": \"\"\n }\n },\n \"gainLabel\": \"POINTS\",\n \"gainUnit\": \"POINTS\",\n \"offerLabel\": \"string\",\n \"enableDisplayIdentifiant\": false,\n \"gainFormatMigrated\": false,\n \"_id\": \"string\",\n \"createdAt\": \"1964-09-29T13:43:43.609Z\",\n \"updatedAt\": \"1992-01-10T20:58:47.771Z\",\n \"displayWalletName\": false,\n \"passBuilderPassTemplateId\": \"string\",\n \"programName\": \"string\",\n \"keysHasChanged\": [\n \"string\",\n \"string\"\n ],\n \"startRow\": \"GAIN\",\n \"middleRow\": \"EXPIRATION_DATE\",\n \"endRow\": \"N_ADHERENT\",\n \"iosHeader\": {\n \"labelEnum\": {\n \"value\": \"\"\n },\n \"valueEnum\": {\n \"value\": \"\"\n },\n \"customLabel\": {\n \"value\": \"\"\n },\n \"customValue\": {\n \"value\": \"\"\n }\n }\n },\n \"startDate\": \"1974-12-29T20:13:01.108Z\",\n \"endDate\": \"1951-01-18T04:18:55.664Z\",\n \"minPoints\": 6248.077602084439,\n \"maxPoints\": 4775.705157207115\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2eea7de-d45d-4f43-a166-5df9d3778ad8", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55d51513-b3fe-4aca-94d7-6a5f6337ec93", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19b2f7dd-c1ae-497d-a985-d9253e628820", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8377a364-e58d-4a53-a719-e21ed6f1f6ec", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5fc2e78-b30d-4725-96e8-a9c6f5496da7", "name": "`OVERLAPPING_COMMUNICATIONS`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Overlapping communications exist for the selected dates\",\n \"errorCode\": \"409:OVERLAPPING_COMMUNICATIONS\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2df42adf-437d-4013-ab34-32d6d33c0227", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications", ":id", "actif-or-inactif" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"ACTIF\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications/:id/actif-or-inactif\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1378bfd-dff4-4252-9083-551f373ee7b0", "name": "Get communication delivery statistics", "request": { "name": "Get communication delivery statistics", "description": { "content": "Delivery statistics for a communication's push notification, per holder of an active loyalty card (with their email and phone number), paginated, with an overall and per-platform (iOS, Android) success summary. The summary also gives the communication's status and its next milestone (start or end).\n\n:::info[Good to know]\n\n- Recipients are the wallet's current active loyalty cards, not a snapshot taken at send time. A recipient with no delivery record yet is `PENDING`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Recipients per page, from 1 to 1,000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "21473f21-778b-4e60-b36f-d4e61c5aa371", "originalRequest": { "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"clientId\": \"string\",\n \"fullName\": \"string\",\n \"platforms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"devicesTotal\": 8377.877625692563,\n \"reachedCount\": 2149.693378821569,\n \"notReachedCount\": 926.8109130467051,\n \"finalStatus\": \"PENDING\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n },\n {\n \"clientId\": \"string\",\n \"fullName\": \"string\",\n \"platforms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"devicesTotal\": 3242.86530075087,\n \"reachedCount\": 9931.400361737658,\n \"notReachedCount\": 9499.90166031743,\n \"finalStatus\": \"DELIVERED\",\n \"email\": \"string\",\n \"phoneNumber\": \"string\"\n }\n ],\n \"totalDocs\": 8432.145937640289,\n \"limit\": 6388.953998193032,\n \"totalPages\": 6579.701974593095,\n \"pagingCounter\": 9762.129414824676,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"summary\": {\n \"communicationStatus\": \"INACTIF\",\n \"statusUpdatedAt\": \"1989-09-21T08:59:43.943Z\",\n \"totalRecipients\": 8520.448807828065,\n \"successCount\": 3362.6276467143643,\n \"failedCount\": 2720.48930191374,\n \"pendingCount\": 7450.044365328567,\n \"globalSuccessRate\": 452.28500849453735,\n \"androidTotal\": 4375.485087362736,\n \"androidSuccessRate\": 7352.706947540169,\n \"iosTotal\": 8684.864843813846,\n \"iosSuccessRate\": 1508.251861813179,\n \"nextMilestoneType\": \"EXPIRY\",\n \"nextMilestoneDate\": {}\n },\n \"page\": 9239.391061937204,\n \"prevPage\": 1026.9121198572973,\n \"nextPage\": 740.6979600370844\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3e4f85-5048-44e7-97f8-d3c8bd56b12c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/communications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "216fac60-051f-443c-a435-cd6a62bc468d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/communications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d851663-0ed4-4d8f-94b3-0b244a0147c1", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/communications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d404249-3721-446d-b4a2-61f7f2006f34", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "communications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Communication ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/communications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "31e727a8-922f-4b23-b0a6-72d1ac78e05a", "name": "Push Notifications", "description": { "content": "Scheduled or triggered notifications on installed passes.", "type": "text/plain" }, "item": [ { "id": "9ad3dc95-23c0-402e-b376-db5717db2387", "name": "Create a push notification", "request": { "name": "Create a push notification", "description": { "content": "Creates a push notification sent on installed loyalty cards, to every holder (`target: ALL`) or to a list of clients (`target: SPECIFIC`), right away (`INSTANT`) or at `scheduleAt` (`SCHEDULED`). Recipients are resolved at creation and stored in `clients`. Returns the created notification.\n\n:::info[Good to know]\n\n- `scheduleAt` is required when `type` is `SCHEDULED`.\n- Recipients are the holders of an active, installed loyalty card: all of them with `target: ALL`, or those listed in `clients` with `target: SPECIFIC` (per-client `title`/`message` override `defaultTitle`/`defaultMessage`). Always send `target`: without it, no recipient is resolved. `category` (`COMMERCIAL` or `INFORMATIVE`) is checked against each client's consent (`pushCommercialEnabled`, `pushInformativeEnabled`) at creation and again at send time, along with the wallet's communication rules. One `PUSH` credit is consumed per recipient (`INSUFFICIENT_CREDIT` if short), and two `target: ALL` scheduled notifications must be at least 10 seconds apart (`409:PUSH_NOTIFICATION_SCHEDULE_CONFLICT`).\n\n:::", "type": "text/plain" }, "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"INSTANT\",\n \"category\": \"INFORMATIVE\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1957-09-07T20:01:18.731Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a422ff8-759a-4500-b808-91bb9d219ce2", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"STORE_CARD\",\n \"BOARDING_PASS\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"2016-04-20T21:41:31.787Z\",\n \"updatedAt\": \"1967-07-16T03:26:05.545Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"clients\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1975-12-05T19:36:38.891Z\",\n \"updatedAt\": \"2010-11-14T18:40:18.296Z\",\n \"category\": \"COMMERCIAL\",\n \"scheduleAt\": \"2026-03-08T05:09:13.857Z\",\n \"sentAt\": \"1978-07-29T07:54:03.204Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c167ad-d7e2-4ab6-a20d-14adfff4e3cf", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INSUFFICIENT_CREDIT`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40208990-ef45-4268-9960-f7c1aad9c369", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c863aee9-24f9-4864-91b4-de28b3a22e5b", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac7cede4-7384-4d01-a64d-7250e91e26d0", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "742c4010-8e8d-4783-8bb8-8e16903d36dc", "name": "`PUSH_NOTIFICATION_SCHEDULE_CONFLICT`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"A notification is already scheduled at this date and time. Please choose another time at least {seconds} seconds apart.\",\n \"errorCode\": \"409:PUSH_NOTIFICATION_SCHEDULE_CONFLICT\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea2a9e24-496f-4d85-a45f-6a2171f0411d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1978-05-13T05:27:15.928Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e5cda26-adad-466c-993a-268f8bfd96ec", "name": "List push notifications", "request": { "name": "List push notifications", "description": { "content": "Paginated list of the wallet's push notifications, instant or scheduled, with their recipients and send date (`sentAt`).\n\n:::info[Good to know]\n\n- A notification with `sentAt` set has been sent; until then, a `SCHEDULED` one can still be changed or deleted.\n\n:::", "type": "text/plain" }, "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sortOrder", "value": "desc", "description": "Sort direction: `ASC` or `DESC`. Default: `DESC`." }, { "disabled": false, "key": "type", "value": "INSTANT", "description": "Filter by type: `INSTANT` or `SCHEDULED`." }, { "disabled": false, "key": "search", "value": "string", "description": "Case-insensitive search in `defaultTitle`, `defaultMessage` or the notification ID." }, { "disabled": false, "key": "sortBy", "value": "createdAt", "description": "Sort field. Default: `createdAt`." }, { "disabled": false, "key": "limit", "value": "10", "description": "Items per page, from 1 to 1,000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "a2785c5a-a751-406c-b5a5-64cdb91300c1", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "INSTANT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"clients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1988-07-24T14:24:41.025Z\",\n \"updatedAt\": \"2020-03-28T01:24:18.735Z\",\n \"category\": \"INFORMATIVE\",\n \"scheduleAt\": \"2021-08-10T04:47:08.011Z\",\n \"sentAt\": \"1968-07-23T05:55:58.590Z\"\n },\n {\n \"wallet\": {\n \"value\": \"\"\n },\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"clients\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1972-01-28T04:16:10.624Z\",\n \"updatedAt\": \"1957-03-06T19:52:50.712Z\",\n \"category\": \"COMMERCIAL\",\n \"scheduleAt\": \"1985-02-03T13:52:47.573Z\",\n \"sentAt\": \"1947-09-17T12:24:19.124Z\"\n }\n ],\n \"totalDocs\": 7169.274049047878,\n \"limit\": 887.0952100002105,\n \"totalPages\": 7005.940338846013,\n \"pagingCounter\": 8504.168342320965,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"page\": 4085.8028758744513,\n \"prevPage\": 8537.136343858343,\n \"nextPage\": 9752.782100809607\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d67572b7-b999-4d5d-b6b0-63f159c90043", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "INSTANT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63498041-150e-42af-898d-ff05f148aa1c", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "INSTANT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9108e481-c0e3-41d7-a157-08c8bd033936", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sortOrder", "value": "desc" }, { "key": "type", "value": "INSTANT" }, { "key": "search", "value": "string" }, { "key": "sortBy", "value": "createdAt" }, { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fa7dfca-d8b8-46bf-8c7f-f4d20f724259", "name": "Get push notification statistics", "request": { "name": "Get push notification statistics", "description": { "content": "Delivery statistics for a push notification, per recipient (devices reached, platforms, final status `DELIVERED`, `FAILED` or `PENDING`), paginated, with an overall and per-platform (iOS, Android) success summary.\n\n:::info[Good to know]\n\n- `PENDING`: not sent yet. `FAILED`: sent, but no device was reached (or no delivery record exists). `DELIVERED`: reached on at least one device.\n\n:::", "type": "text/plain" }, "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "10", "description": "Recipients per page, from 1 to 1,000. Default: `10`." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number, starting at 1. Default: `1`." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "470c0a6c-8f58-4aaa-8528-c7d8d0af3795", "originalRequest": { "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"docs\": [\n {\n \"clientId\": \"string\",\n \"fullName\": \"string\",\n \"platforms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"devicesTotal\": 1555.3400307446784,\n \"reachedCount\": 3199.7621310031677,\n \"notReachedCount\": 2889.7652961000576,\n \"finalStatus\": \"FAILED\",\n \"email\": \"string\"\n },\n {\n \"clientId\": \"string\",\n \"fullName\": \"string\",\n \"platforms\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"devicesTotal\": 623.316914840879,\n \"reachedCount\": 8587.561637371702,\n \"notReachedCount\": 9307.089368750938,\n \"finalStatus\": \"FAILED\",\n \"email\": \"string\"\n }\n ],\n \"totalDocs\": 9729.977066979427,\n \"limit\": 5464.98811469822,\n \"totalPages\": 5799.706094438333,\n \"pagingCounter\": 6239.515302787513,\n \"hasPrevPage\": true,\n \"hasNextPage\": false,\n \"summary\": {\n \"totalRecipients\": 3801.847990700753,\n \"successCount\": 4343.551784852113,\n \"failedCount\": 5246.6737766483475,\n \"pendingCount\": 3218.839222568286,\n \"globalSuccessRate\": 1605.6983033229221,\n \"androidTotal\": 224.20321115747655,\n \"androidSuccessRate\": 6995.708062471311,\n \"iosTotal\": 9835.571142254674,\n \"iosSuccessRate\": 94.36827204180709\n },\n \"page\": 5063.945559643783,\n \"prevPage\": 3159.549936569799,\n \"nextPage\": 1870.13373150551\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d7d4d7-a00d-42b7-b906-7ed118c0249a", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "841e9a73-3db4-4ab3-9fba-d68f9b875d00", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e359c3-f02a-4c24-9563-804b03fb7df2", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/push-notifications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd8598c-5012-481f-a91b-2c26019261a4", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications", ":id", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "10" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications/:id/stats\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3e49c78-9000-4786-a325-33af4b6f57b7", "name": "Get a push notification", "request": { "name": "Get a push notification", "description": { "content": "Returns a push notification by ID, with its recipients, type, category, and scheduled and sent dates.", "type": "text/plain" }, "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "40f61a91-8713-4870-ae30-1a29d8784c6a", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"GENERIC\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2005-04-28T02:08:14.050Z\",\n \"updatedAt\": \"1980-05-31T14:14:52.187Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"clients\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1957-09-03T00:38:42.330Z\",\n \"updatedAt\": \"2001-08-16T02:56:37.830Z\",\n \"category\": \"COMMERCIAL\",\n \"scheduleAt\": \"1958-02-22T11:19:02.803Z\",\n \"sentAt\": \"2009-03-19T20:22:36.015Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8affc0d-a4c1-4a60-93de-b69c74a7d879", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "644d38df-9031-4e6c-a18f-78ef8b2e2b51", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a44f1eda-a501-4d9e-91e0-f4f242558c3d", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c884290-1bc1-4e26-8f57-5df84f721298", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79eeedfc-4a8e-48b3-aff2-334d3c9a202f", "name": "Update a push notification", "request": { "name": "Update a push notification", "description": { "content": "Replaces a push notification's content, target, category or schedule and recomputes its recipients. Use it to change a scheduled notification before it is sent. Returns the updated notification.\n\n:::info[Good to know]\n\n- `scheduleAt` is required when `type` is `SCHEDULED`.\n- Recipients are recomputed from the request body: send `target`, `clients`, `defaultTitle` and `defaultMessage` again as for a creation, or the omitted titles and messages are left empty. For an `INSTANT` notification, `scheduleAt` is reset to now, so it is sent on the next dispatch run. The `PUSH` credit and 10-second gap checks apply as on creation.\n\n:::", "type": "text/plain" }, "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"category\": \"INFORMATIVE\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"2008-06-20T23:20:37.324Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6cb5838-d847-4e62-8bb2-e21b02bb35b5", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"GENERIC\",\n \"OFFER\"\n ],\n \"expiredCleanupEnabled\": false,\n \"_id\": \"string\",\n \"createdAt\": \"2005-04-28T02:08:14.050Z\",\n \"updatedAt\": \"1980-05-31T14:14:52.187Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"ALL\",\n \"type\": \"SCHEDULED\",\n \"clients\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"passBuilderPassId\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"_id\": \"string\",\n \"createdAt\": \"1957-09-03T00:38:42.330Z\",\n \"updatedAt\": \"2001-08-16T02:56:37.830Z\",\n \"category\": \"COMMERCIAL\",\n \"scheduleAt\": \"1958-02-22T11:19:02.803Z\",\n \"sentAt\": \"2009-03-19T20:22:36.015Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d870ce7e-9977-412d-bc63-da1bf146906c", "name": "`VALIDATION_ERROR` · `INVALID_JSON` · `INSUFFICIENT_CREDIT`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ca7cfa3-701e-4208-b81a-0f3d06fde0fd", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14a9f08f-cb2a-4d9d-b592-4df86e556c45", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54cbb79b-d1c8-405b-a78e-a4f372b49245", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e241178b-feb9-4c5d-9c8c-486c2f17bc14", "name": "`PUSH_NOTIFICATION_SCHEDULE_CONFLICT`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"A notification is already scheduled at this date and time. Please choose another time at least {seconds} seconds apart.\",\n \"errorCode\": \"409:PUSH_NOTIFICATION_SCHEDULE_CONFLICT\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e37c67b-5d39-4314-8f8f-8698400642b8", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"defaultTitle\": \"string\",\n \"defaultMessage\": \"string\",\n \"target\": \"SPECIFIC\",\n \"type\": \"SCHEDULED\",\n \"category\": \"COMMERCIAL\",\n \"clients\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"scheduleAt\": \"1981-07-08T01:00:57.617Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff7a54b7-f5f0-4ff5-8204-459d5b3e5a3c", "name": "Delete a push notification", "request": { "name": "Delete a push notification", "description": { "content": "Deletes a push notification. A scheduled notification deleted before its send time is not sent. Returns `{\"deleted\": true}`.", "type": "text/plain" }, "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "671a1fdb-f451-4410-9f2e-a2d8feceb257", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8a439c4-595a-4d47-9d6e-223dfab36045", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7bf15a4-4f31-4204-9c0b-c147f536b2a7", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb54508b-cda5-4128-a94b-c9f4aec3fdf5", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4a5e8f-a386-4302-9742-bdba6a9b45cb", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "push-notifications", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Push notification ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/push-notifications/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fc788686-d4e8-4502-b952-46669cb87000", "name": "Notification Templates", "description": { "content": "Content of the emails and SMS sent by eldo wallet.", "type": "text/plain" }, "item": [ { "id": "0a1be52f-717b-4383-a762-ff707a1cade9", "name": "Create a notification template", "request": { "name": "Create a notification template", "description": { "content": "Creates the notification template of a type (`notificationType`) for the wallet. An omitted email subject, email body or push notification text falls back to the type's default content. One template per type and wallet: use the update to change an existing one.\n\n:::info[Good to know]\n\n- `emailSubject` and `htmlContent` make up the email; `htmlContent` is an EJS template (`<%= customerFirstName %>`, `customerLastName`, `jwtLink`, `notificationMessage`, `websiteLink`, `year`…). `smsMessage` uses `{{customerFirstName}}`, `{{jwtLink}}`, `{{consentLink}}` placeholders and falls back to `notificationMessage` when empty; the consent-management link is always added to emails and SMS. `notificationMessage` is the push text (500 characters max, like `smsMessage` and `emailSubject`). A second template of the same type returns `409:TEMPLATE_ALREADY_EXISTS`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b817a94-413b-4514-90da-a6ee5f6653de", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": false,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"GENERIC\",\n \"GENERIC\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1981-02-04T05:00:03.814Z\",\n \"updatedAt\": \"1968-12-18T15:03:31.818Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"notificationType\": \"WELCOME_CRM_CLIENTS\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1979-03-28T11:20:27.672Z\",\n \"updatedAt\": \"1964-09-28T03:03:29.144Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "976193ef-c3b6-4bcc-af3e-c51f25676cd9", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85db46be-53f4-4189-8aba-97efc7d84b7c", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d55378c9-a189-4997-b612-bd055cbed9bb", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e98b8c8-3f2d-4867-ae33-36203f96e27e", "name": "`TEMPLATE_ALREADY_EXISTS`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Template already exists\",\n \"errorCode\": \"409:TEMPLATE_ALREADY_EXISTS\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f209d2c-529a-4c6f-92bf-e6a582bd0c9f", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"NEW_EVENT\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8728144f-1c48-40cd-a80c-b4a031159de8", "name": "List notification templates", "request": { "name": "List notification templates", "description": { "content": "Lists all of the wallet's notification templates (at most one per notification type), with the email subject and HTML body, the SMS text and the push notification text.\n\n:::info[Good to know]\n\n- Loyalty types (`*_LOYALTY`, `EARNINGS_UPDATE`) are always available; the others require their pass type to be enabled on the wallet (or `ALL`): `*_COMMUNICATION` for offers, `*_COUPON` and `WELCOME_*` for coupons, `*_EVENT` for events, `*_TRANSIT`/`TRANSIT_TICKET` for transit, `*HOTEL_RESERVATION` for hotels, `CINEMA_TICKET` for cinema; `PUSH_CAMPAIGN_*` only with `ALL`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "1cb82374-b647-42af-89ca-a857c4fa7dc7", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"notificationType\": \"REMINDER_LOYALTY\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1980-05-01T10:29:36.273Z\",\n \"updatedAt\": \"2006-07-02T14:59:20.660Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n },\n {\n \"wallet\": {\n \"name\": {\n \"value\": \"\"\n },\n \"logo\": {\n \"value\": \"\"\n },\n \"icon\": {\n \"value\": \"\"\n },\n \"displayIdentifiant\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"identifierQr\": {\n \"value\": \"\"\n },\n \"website\": {\n \"value\": \"\"\n },\n \"servicePhone\": {\n \"value\": \"\"\n },\n \"businessPhone\": {\n \"value\": \"\"\n },\n \"socialMedia\": {\n \"value\": \"\"\n },\n \"additionalContacts\": {\n \"value\": \"\"\n },\n \"termsAndConditions\": {\n \"value\": \"\"\n },\n \"webHookUrl\": {\n \"value\": \"\"\n },\n \"rootDomain\": {\n \"value\": \"\"\n },\n \"allowedPasses\": {\n \"value\": \"\"\n },\n \"expiredCleanupEnabled\": {\n \"value\": \"\"\n },\n \"_id\": {\n \"value\": \"\"\n },\n \"createdAt\": {\n \"value\": \"\"\n },\n \"updatedAt\": {\n \"value\": \"\"\n },\n \"androidLogo\": {\n \"value\": \"\"\n },\n \"passBuilderPassTemplateId\": {\n \"value\": \"\"\n },\n \"passBuilderBusinessId\": {\n \"value\": \"\"\n },\n \"passBuilderToken\": {\n \"value\": \"\"\n },\n \"address\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n }\n },\n \"notificationType\": \"TRANSIT_TICKET\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1991-12-27T08:12:15.340Z\",\n \"updatedAt\": \"1964-01-25T08:44:37.738Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68190c57-e0c8-4725-abfc-4f14cce5d044", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3c10aa9-2f30-45ee-8d29-e7a348e127b3", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e16c9a3-01f8-427d-a1dc-e0c2aa4ce68b", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d30fc0e7-4f5c-4cc3-b1c1-130759bb84be", "name": "Get the notification template for a type", "request": { "name": "Get the notification template for a type", "description": { "content": "Returns the wallet's notification template for a type, and creates it with the default content if it doesn't exist yet. The type must match a pass type enabled on the wallet.\n\n:::info[Good to know]\n\n- Returns `403` when the type's pass type is not enabled on the wallet (loyalty types are always available).\n\n:::", "type": "text/plain" }, "url": { "path": [ "notification-templates", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "notificationType", "value": "UPDATE_COUPON", "description": "(Required) Notification type, for example `NEW_LOYALTY`, `UPDATE_LOYALTY`, `NEW_COMMUNICATION`, `NEW_COUPON` or `PUSH_CAMPAIGN_COMMERCIAL`. See the schema enum for the full list." } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "f6c39926-7e0a-4dd9-be24-940bd159550c", "originalRequest": { "url": { "path": [ "notification-templates", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "notificationType", "value": "UPDATE_COUPON" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"COUPON\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1952-12-09T20:06:06.896Z\",\n \"updatedAt\": \"2021-01-27T16:37:35.684Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"notificationType\": \"EXPIRED_COMMUNICATION\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1994-12-10T01:18:20.825Z\",\n \"updatedAt\": \"1960-03-02T17:31:59.202Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cacfd494-62d0-4b2e-9056-c6e822cff2be", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "notificationType", "value": "UPDATE_COUPON" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates/type\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a11bf356-a90f-4540-bf84-58637ced4350", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "notificationType", "value": "UPDATE_COUPON" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates/type\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49d47f8c-387b-479e-898a-87e2b38e835c", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates", "type" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "notificationType", "value": "UPDATE_COUPON" } ], "variable": [] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates/type\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f7fd60e-70af-48f0-a320-a0c11e825c22", "name": "Get a notification template", "request": { "name": "Get a notification template", "description": { "content": "Returns a notification template by ID.", "type": "text/plain" }, "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "cc766423-51a0-4265-aab0-1ceb418c800f", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"COUPON\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1952-12-09T20:06:06.896Z\",\n \"updatedAt\": \"2021-01-27T16:37:35.684Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"notificationType\": \"EXPIRED_COMMUNICATION\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1994-12-10T01:18:20.825Z\",\n \"updatedAt\": \"1960-03-02T17:31:59.202Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea536aa-4459-41e5-abd1-b8363df379f0", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91907df0-06ec-4590-900d-2c5051b2e369", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7194d03b-1108-4ebb-98f7-3dbfb4e4f347", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31cfdb49-12f4-4af1-acef-d0d69ca8f86d", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e27a6f72-6d26-42c5-b19b-df009f704834", "name": "Update a notification template", "request": { "name": "Update a notification template", "description": { "content": "Updates a notification template: email subject and body, SMS text or push notification text. Only the fields you send are changed. Returns the updated template.\n\n:::info[Good to know]\n\n- Same fields and variables as on creation. Saving an `UPDATE_LOYALTY`, `EARNINGS_UPDATE`, event, transit or hotel template refreshes the matching pass templates in the background, without notifying holders.\n\n:::", "type": "text/plain" }, "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a19dcb6-7485-41d2-aedf-b273196fd743", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"wallet\": {\n \"name\": \"string\",\n \"logo\": \"string\",\n \"icon\": \"string\",\n \"displayIdentifiant\": true,\n \"identifier\": \"string\",\n \"identifierQr\": \"string\",\n \"website\": \"string\",\n \"servicePhone\": \"string\",\n \"businessPhone\": \"string\",\n \"socialMedia\": {\n \"linkedin\": {\n \"value\": \"\"\n },\n \"facebook\": {\n \"value\": \"\"\n },\n \"instagram\": {\n \"value\": \"\"\n },\n \"tiktok\": {\n \"value\": \"\"\n },\n \"twitter\": {\n \"value\": \"\"\n },\n \"youtube\": {\n \"value\": \"\"\n },\n \"snapchat\": {\n \"value\": \"\"\n },\n \"pinterest\": {\n \"value\": \"\"\n },\n \"reddit\": {\n \"value\": \"\"\n },\n \"whatsapp\": {\n \"value\": \"\"\n },\n \"telegram\": {\n \"value\": \"\"\n }\n },\n \"additionalContacts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"termsAndConditions\": {\n \"type\": {\n \"value\": \"\"\n },\n \"customUrl\": {\n \"value\": \"\"\n },\n \"pdfUrl\": {\n \"value\": \"\"\n }\n },\n \"webHookUrl\": \"string\",\n \"rootDomain\": \"string\",\n \"allowedPasses\": [\n \"CINEMA\",\n \"COUPON\"\n ],\n \"expiredCleanupEnabled\": true,\n \"_id\": \"string\",\n \"createdAt\": \"1952-12-09T20:06:06.896Z\",\n \"updatedAt\": \"2021-01-27T16:37:35.684Z\",\n \"androidLogo\": \"string\",\n \"passBuilderPassTemplateId\": \"string\",\n \"passBuilderBusinessId\": \"string\",\n \"passBuilderToken\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\"\n },\n \"notificationType\": \"EXPIRED_COMMUNICATION\",\n \"walletSetting\": {},\n \"_id\": \"string\",\n \"createdAt\": \"1994-12-10T01:18:20.825Z\",\n \"updatedAt\": \"1960-03-02T17:31:59.202Z\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"htmlCode\": \"string\",\n \"smsMessage\": \"string\",\n \"notificationMessage\": \"string\",\n \"emailSubject\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b266407-c94d-4e91-9d01-44335b599f21", "name": "`VALIDATION_ERROR` · `INVALID_JSON`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Validation error!\",\n \"errorCode\": \"400:VALIDATION_ERROR\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\",\n \"validationErrors\": [\n {\n \"field\": \"email\",\n \"message\": \"email must be an email\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2dd075-d2fb-4c6e-b443-974642c3d9a4", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ed5561a-5c39-4fd4-9847-87257c5a9b43", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641e28f8-3f69-4cbe-8228-c8b5a10f2a9d", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e13fbb04-00a0-4280-8d1e-393e0e75dd2a", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notificationType\": \"WELCOME_INTERNAL_CLIENTS\",\n \"htmlContent\": \"string\",\n \"htmlTemplate\": \"string\",\n \"notificationMessage\": \"string\",\n \"smsMessage\": \"string\",\n \"emailSubject\": \"string\",\n \"walletSettings\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75002fd0-188f-4e21-83ab-4476876c5b1c", "name": "Delete a notification template", "request": { "name": "Delete a notification template", "description": { "content": "Deletes a notification template. It is recreated with the default content the next time it is accessed by type.", "type": "text/plain" }, "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "70071328-5be8-4f50-b01d-441b13d33e64", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15485751-44dd-41ac-b7a5-309252b30ee5", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "455413bd-72b8-450c-a806-b3a3d9a0b07d", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8adb3645-e277-41d4-924e-6eeb8d983208", "name": "`MODEL_NOT_FOUND`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Model not found!\",\n \"errorCode\": \"404:MODEL_NOT_FOUND\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df570c73-a3bf-4efd-b64e-117a846500f9", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "notification-templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) Notification template ID (24-character hexadecimal ObjectId)." } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/notification-templates/:id\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "93eb3c6e-3b3e-4754-874c-f27da6530bfa", "name": "Bulk Operations", "description": { "content": "Track asynchronous bulk operations.", "type": "text/plain" }, "item": [ { "id": "9b19d25d-f88c-4950-91e9-1a230fbd10ec", "name": "Get the status of a bulk operation", "request": { "name": "Get the status of a bulk operation", "description": { "content": "Returns the progress and results of a bulk operation started by your wallet (bulk send, update or delete). Poll this route with the `operationId` returned at launch until `status` is `completed` or `failed`.\n\n:::info[Good to know]\n\n- `status` goes from `pending` to `processing`, then `completed` or `failed`. `completed` does not mean every item succeeded: check `failureCount` and `operationErrors`. If you passed a `webhookUrl` at launch, it is called when the operation reaches `completed`.\n\n:::", "type": "text/plain" }, "url": { "path": [ "bulk-operations", ":operationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "507f1f77bcf86cd799439011", "key": "operationId", "description": "(Required) Unique identifier for the bulk operation (MongoDB _id)" } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e431f2d5-35c1-40f7-9d53-51c2ce35ae15", "originalRequest": { "url": { "path": [ "bulk-operations", ":operationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "507f1f77bcf86cd799439011", "key": "operationId", "description": "(Required) Unique identifier for the bulk operation (MongoDB _id)" } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operationId\": \"507f1f77bcf86cd799439011\",\n \"totalItems\": 100,\n \"successCount\": 95,\n \"failureCount\": 5,\n \"status\": \"pending\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"operationErrors\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"message\": \"Client not found\",\n \"code\": \"404:MODEL_NOT_FOUND\"\n }\n ],\n \"results\": [\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n },\n {\n \"itemId\": \"507f1f77bcf86cd799439011\",\n \"result\": {}\n }\n ],\n \"completedAt\": \"2024-01-01T00:05:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10302e55-fba3-4d7a-95ed-14a7ca86897f", "name": "`UNAUTHORIZED`", "originalRequest": { "url": { "path": [ "bulk-operations", ":operationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "507f1f77bcf86cd799439011", "key": "operationId", "description": "(Required) Unique identifier for the bulk operation (MongoDB _id)" } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unauthorized!\",\n \"errorCode\": \"401:UNAUTHORIZED\",\n \"path\": \"/bulk-operations/:operationId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "518bf95f-a010-42c2-8059-55c44d0e4714", "name": "`FORBIDDEN`", "originalRequest": { "url": { "path": [ "bulk-operations", ":operationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "507f1f77bcf86cd799439011", "key": "operationId", "description": "(Required) Unique identifier for the bulk operation (MongoDB _id)" } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Forbidden!\",\n \"errorCode\": \"403:FORBIDDEN\",\n \"path\": \"/bulk-operations/:operationId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "106cf341-3f62-447b-9b28-a2877b7407d7", "name": "`UNKNOWN_ERROR`", "originalRequest": { "url": { "path": [ "bulk-operations", ":operationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "507f1f77bcf86cd799439011", "key": "operationId", "description": "(Required) Unique identifier for the bulk operation (MongoDB _id)" } ] }, "header": [ { "disabled": false, "description": "Language for responses", "key": "x-lang", "value": "en" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Unknown error!\",\n \"errorCode\": \"500:UNKNOWN_ERROR\",\n \"path\": \"/bulk-operations/:operationId\",\n \"date\": \"2026-01-15T09:30:00.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api-v2.test.eldowallet.fr", "type": "string" }, { "key": "token", "value": "", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "info": { "_postman_id": "3341291c-0d82-48f7-a7a1-edadd18aeeae", "name": "eldo wallet API v2 (test)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from the eldo wallet OpenAPI specification. Paste your test API token into the collection's `token` variable (Variables tab), then send any request. Documentation: https://developers.eldowallet.fr/en/api" } }