{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"eae8d08b-d3d0-453e-ac42-f225a542573d","name":"FanPass API","description":"**CONFIDENTIAL NOTICE. The information contained in this document is strictly confidential****and contains proprietary information. It may only be used by the intended parties and is****subject to the terms of any other confidentiality or nondisclosure agreement between parties.**\n\n# Overview (Please read!)\n\nFanPass lets you push your own data into FanReach so it can power personalization and targeting.\n\nTwo things you can push:\n\n**Imported Segments** — lists of user IDs that FanReach uses to target content, push notifications, and campaigns. Send a list inline or upload a file for larger imports.\n\n**User Model Attributes** — key-value data sent via the `userProperties` field that updates attributes on an individual user's record. There are two distinct types:\n\n- **Platform User Properties** (`user_properties.\\*`) — a pre-defined set of attributes (e.g. `user_properties.sth`, `user_properties.ticketing_plans`) built into the FanReach User Model. These feed personalization rules and are automatically synced to GA4, attaching to every analytics event for enhanced reporting. → [View full list of Platform User Properties](https://docs.google.com/document/d/1xSwhb64_uVrM37b2K8tcTA3pb_x_nC75PkPVdq8vTGw/edit?tab=t.0#heading=h.ybdyyjajmgj5)\n    \n- **Custom Attributes** (`custom.\\*`) — attributes you define yourself (e.g. `custom.loyalty_tier`). These must be registered in the FanReach Portal before use. They power personalization and targeting but are not synced to GA4.\n    \n\n# Endpoints in this Collection\n\n| Request | Method & Path | Purpose |\n| --- | --- | --- |\n| **Create/Update Segment** | `POST /api/v1/segments` | Create or update an Imported Segment from an inline `userIds` array (JSON body). |\n| **Import Segment via CSV upload** | `POST /api/v1/segments` | Create or update an Imported Segment by uploading a CSV/XLSX/XLS/ZIP file (`multipart/form-data`). Recommended for large segments. |\n| **Get Segment Import Status** | `POST /api/v1/segment_import_status` | Poll the progress of a file-based segment import using the `firebase_imported_segment_id` returned by the upload. |\n| **Update User Properties** | `POST /api/v1/update_user` | Enrich user records with platform and custom user attributes. |\n\nThe two segment-creation requests target the **same** `POST /api/v1/segments` endpoint — the API selects file mode when the request is sent as `multipart/form-data` with a `file` part, and JSON mode when a JSON body is sent.\n\n# Getting Started with this Postman Collection\n\nThis collection can be imported into any Postman workspace. It allows you to explore the FanPass API, validate your integration, and reproduce issues for support. It uses variables to manage the API host and your authentication token.\n\nTo get started:\n\n**1\\. Import this collection into your postman workspace:**\n\n- In the top right bar of this webpage, click on the **Run in Postman**.\n    \n- Select the **Workspace** you'd like to import this collection into.\n    \n\n**2\\. Select the Collection and Go to Variables:**\n\n- In the sidebar, click on the **FanPass API** collection.\n    \n- Select the **Variables** tab.\n    \n\n**3\\. Set Your API Token:**\n\n- You will see a variable named `api_access_token`.\n    \n- In the **Current Value** column for that variable, **paste your JWT Token**.\n    \n- This **JWT Token** is generated in the Fanreach Portal. It is unique to your user for auditing purposes. Ensure your JWT remains secure and do not share it externally. If your token is compromised, contact FanReach support immediately to issue a new one.\n    \n\n> **Security Best Practice:** Using the **Current Value** field ensures your secret token remains on your local machine and will not be synced with Postman's servers or exposed if you share the collection. \n  \n\nThe `domain` variable is already set to the production host. Once your token is set, you can run any request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1065403","team":24491,"collectionId":"eae8d08b-d3d0-453e-ac42-f225a542573d","publishedId":"2sB2x6kC5M","public":true,"publicUrl":"https://fanpass-api-docs.fanreachdata.io","privateUrl":"https://go.postman.co/documentation/1065403-eae8d08b-d3d0-453e-ac42-f225a542573d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2025-06-12T18:11:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/536d5a9d5fc5399d0ec2aaca1b4999c95e607305df9cd0178b6ea402c0fe1e2a","favicon":"https://res.cloudinary.com/postman/image/upload/v1611783233/team/kuidwouyzmz1i5zzttqa.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://fanpass-api-docs.fanreachdata.io/view/metadata/2sB2x6kC5M"}