API ENDPOINTS:
CARD ACCOUNT CREATION
This endpoint is for creating a new Card Account for a customer.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• aff: (varchar)
o Partner ID that was setup
• domain: (varchar)
o Domain or email of the account
• the_classification: (enum)
o Personal/Professional
o Food/Beverage
o Retail/Ecommerce
o Health/Wellness
o Community/Tourism
o Attractions/Experiences
o Education/Institutions
o Venues
o Events
Example
https://addthispass.com/api/card-activation/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&aff=A12345&domain=12345679@gmail.com&the_classification=Personal/Professional
Response
• SUCCESS:
o {"SUCCESS":"Key Activated.","ACCOUNT":"2tCJvk="}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Missing Info."}
o {"ERROR":"Sorry This Account Already Exists. Please Try Again."}
CARD CREATION
This endpoint is for creating a new Card in the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-managment/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• name: (varchar)
o Card name
Example
https://addthispass.com/api/card-management/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&name=New%20Card
Response
• SUCCESS:
o {"SUCCESS":"Card Created/Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD MAIN SETTINGS
AND WEBHOOKS
This endpoint is for managing the 'Main Settings' section in the dashboard.
Endpoint
Request Parameters (all required)
Request Parameters (all optional)
Example
Response
Endpoint
https://addthispass.com/api/card-main-settings/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• timezone: (enum)
o -7 (-12 hours)
o -6 (-11 hours) - Hawaii
o -5 (-10 hours)
o -4 (-9 hours) - Alaska
o -3 (-8 hours) - Pacific
o -2 (-7 hours) - Mountain
o -1 (-6 hours) - Central
o 0 (-5 hours) - Eastern
o 1 (-4 hours)
o 2 (-3 hours)
o 3 (-2 hours)
o 4 (-1 hours)
o 5 (+0 hours)
o 6 (+1 hours) - European
o 7 (+2 hours)
o 8 (+3 hours)
o 9 (+4 hours)
o 10 (+5 hours)
o 11 (+6 hours)
o 12 (+7 hours)
o -12 (+8 hours)
o -11 (+9 hours)
o -10 (+10 hours)
o -9 (+11 hours)
o -8 (+12 hours)
• geo_distance: (string)
o default geo distance in feet for geo locational messages
• default_apple_wallet: (enum)
o apple - For Apple phones, Cards will load in the Apple Wallet (default)
o the_wallet - For Apple phones, Cards will load in the 'Mobile Wallet'
o user_preference - For Apple phones, Card will ask to load on Apple Wallet or 'Mobile Wallet'
• default_android_wallet: (enum)
o the_wallet - For Android phones, Cards will load in the 'Mobile Wallet' (default)
o google - For Android phones, Cards will load in the Google Wallet
o user_preference - For Android phones, Card will ask to load on Google Wallet or 'Mobile Wallet'
• mp_status: (enum)
o yes (default)
o no – Card will not be listed on the Card Store (https://mobilewallet.cards/cards)
------------------------------------------------------------------------------------
o mp_description: (string) – RECOMMENDED IF 'mp_status' IS SET TO 'YES'
§ public description in the Card Store
o mp_keywords: (string) – RECOMMENDED IF 'mp_status' IS SET TO 'YES'
§ keywords to have this Card discovered in the Card Store
Request Parameters (all optional)
• webhook_url: (varchar) o This is where webhook events will be POSTED
o Example: https://example.com/api_hook.php
o Variables sent as POST:
§ 'action' = the trigger actions
§ 'serial' = device serial number
o Webhook Callbacks Include:
o Card added to Wallet
o Card 'Automatic Updates' was disabled/Card was deleted
Example
https://addthispass.com/api/card-main-settings/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2odE&geo_distance=100&timezone=-1&mp_status=yes&mp_description=Test%20Description&mp_keywords=Test1,%20Test2
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD FRONTSIDE SETTINGS
This endpoint is for managing the 'Frontside Settings' section in the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-front-settings/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• welcome_text: (string)
o the text shown when a card prompt is displayed to a user
• suspended_by_default: (enum)
o no (default)
o yes – will suspend the card automatically with text directions below:
---------------------------------------------------------------------------------------
o suspended_header_text: (string) – REQUIRED IF 'SUSPENDED_BY DEFAULT' IS SET to 'YES'
§ the header to the suspension text
o suspended_line1_text: (string)
§ the first line to the suspension text
o suspended_line2_text: (string)
§ the second line to the suspension text to use the auto approval sheet, use the Endpoint (CARD REGISTRATION AUTO APPROVAL)
------------------------------------------------------------------------------------
• push_show: (enum) – option is unavailable if 'SUSPENDED_BY DEFAULT' IS SET to 'YES'
o no (default)
o yes – will show the latest push
o intro – will push a customized intro push
-------------------------------------------------------------------------------------
o push_welcome_1: (string) – REQUIRED IF 'PUSH_SHOW' IS SET to 'INTRO'
§ the actual push message to display
o push_welcome_2: (string)
§ the second line of the push message
o push_welcome_3: (string)
§ the third line of the push message
------------------------------------------------------------------------------------
• qr_source: (enum)
o none (default) – admin will use the barcode module to generate
o sheet – upload a sheet of pre-define barcodes by device – use the Endpoint (CARD DYNAMIC BARCODES)
o name – name will be the source of the barcode (from registration)
o email – email will be the source of the barcode (from registration)
o phone – phone will be the source of the barcode (from registration)
o address – address will be the source of the barcode (from registration)
o other – other will be the source of the barcode (from registration)
• qr_format: (enum)
o PKBarcodeFormatQR (default) – QR code
o PKBarcodeFormatCode128 – UPC code 128
Example
https://addthispass.com/api/card-front-settings/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2odE&welcome_text=Press%20Add%20To%20Get%20Our%20Card!&suspended_by_default=no&push_show=no&qr_source=none&qr_format=PKBarcodeFormatQR
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD BACKSIDE MANAGEMENT
This endpoint is for managing the 'Backside Settings' section in the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-back-settings/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• history: (int)
o 0-30 - set number of historical message to be present on the backside
• registration_header: (string)
o sets the header copy for Registration (optional parameter)
• registration_name: (enum)
o hidden - won't show on Registration
o visible_optional - shown on Registration by optional
o visible_required - shown on Registration and is required (default)
• registration_email: (enum)
o hidden - won't show on Registration
o visible_optional - shown on Registration by optional
o visible_required - shown on Registration and is required (default)
• registration_phone: (enum)
o hidden - won't show on Registration
o visible_optional - shown on Registration by optional (default)
o visible_required - shown on Registration and is required
• registration_address: (enum)
o hidden - won't show on Registration
o visible_optional - shown on Registration by optional (default)
o visible_required - shown on Registration and is required
• registration_other: (enum)
o hidden - won't show on Registration (default)
o visible_optional - shown on Registration by optional
o visible_required - shown on Registration and is required
• registration_other_name: (string)
o sets the 'other' Registration field name
• other_unique: (enum)
o yes - if set, the 'other' Registration field is unique to this Card; it cannot be duplicated
o no - if unset, the 'other' Registration field is NOT unique to this Card; it can be duplicated (default)
• other_onetime: (enum)
o yes - if set, the 'other' Registration field can only be entered once during Registration; it cannot be edited later
o no - if set, the 'other' Registration field can be edited any time (default)
• exclusive: (varchar)
o exclusive content that is revealed once a Card Holder has Registered the Card
• sharing: (enum) - Must have 'Mobile Wallet' for this to work
o true - if set, the Card can be shared with the Card Share button (default)
o false - if set, the Card cannot be shared; the Card Share button is not visible
Example
https://addthispass.com/api/card-back-settings/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=0YwV&sharing=false&history=5®istration_header=test®istration_name=hidden®istration_email=visible_optional®istration_phone=visible_required®istration_address=hidden®istration_other=hidden®istration_other_name=customerID&other_unique=no&other_onetime=yes&exclusive=123<BR>456
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD PREFERENCES
This endpoint is for managing the Card backside preferences section in the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-preferences/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• action: (enum)
o add - used for adding a new preference
o edit – used for updating existing preference
o delete – used for deleting preference
• name: (string)
o this sets the name preference (needed for actions 'add' or 'update')
• id: (int)
o this modifies that preference (needed for actions 'update' or 'delete')
Example
https://addthispass.com/api/card-preferences/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=0YwV&action=edit&name=Hours&id=1003
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD DESIGN MANAGEMENT
This endpoint is for managing the Card design section in the dashboard.
Endpoint
Request Parameters (all required)
Request Parameters (all optional)
Example
Response
Endpoint
https://addthispass.com/api/card-management/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar) – DO NOT CARD IF CREATING A NEW CARD
o card_id to make edits
• name: (varchar)
o name of the Card
• logo_image: (varchar)
o URL of hosted image – must include http/s (be jpg/png/gif and less then 1MB)
• style: (enum)
o color
o image
o if style = 'color':
§ background: (varchar)
• 6 digit hex color of the background
§ text: (varchar)
• 6 digit hex color of the text
§ banner_image: (varchar) - OPTIONAL
• URL of hosted image – must include http/s (be jpg/png/gif and less then 1MB)
§ banner_clear: (varchar) - OPTIONAL
• Set to "true" and this will clear out the current banner_image. If replacing banner, you can just use the "banner_image" with a new URL. This is only for clearing the Card of any Banner.
o if style = 'image':
§ bg_image: (varchar)
• URL of hosted image – must include http/s (be jpg/png/gif and less then 1MB)
Request Parameters (all optional)
• phone: (varchar)
o phone number of the Card
• email: (varchar)
o email address of the Card
• address: (varchar)
o primary address of the Card
• surrounding: (varchar)
o surrounding area of the Card
• website_name: (varchar)
o website name of the Card
• website: (varchar)
o website of the Card
• link1_name: (varchar)
o link1 name of the Card
• link1: (varchar)
o link1 of the Card
• link2_name: (varchar)
o link2 name of the Card
• link2: (varchar)
o link2 of the Card
• monday: (varchar)
o monday hours of the Card
• tuesday: (varchar)
o tuesday hours of the Card
• wednesday: (varchar)
o wednesday hours of the Card
• thursday: (varchar)
o thursday hours of the Card
• friday: (varchar)
o friday hours of the Card
• saturday: (varchar)
o saturday hours of the Card
• sunday: (varchar)
o sunday hours of the Card
• facebook: (varchar)
o facebook link of the Card
• twitter: (varchar)
o twitter link of the Card
• instagram: (varchar)
o instagram link of the Card
• linkedin: (varchar)
o linkedin link of the Card
• yelp: (varchar)
o yelp link of the Card
• google: (varchar)
o google link of the Card
• youtube: (varchar)
o youtube link of the Card
• more: (varchar)
o more information box for the Card
• header1: (varchar)
o line 1 on the front of the Card in top upper right
• header2: (varchar)
o line 2 on the front of the Card in top upper right
---------------------------------------------------------------------------------
• html: (varchar) - 'Mobile Wallet' Only
o this supports HTML such as links, images, iframes and even inline JS
• background_video: (varchar) - 'Mobile Wallet' Only
o MP4, YouTube or Vimeo link
• background_blurr: (enum) - 'Mobile Wallet' Only
o yes (default)
o no
Example
https://addthispass.com/api/card-management/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z&name=test20AAAa&logo_image=https://infopasses.com/logos/logo-white-transparent.png&style=image&bg_image=https://infopasses.com/wpcontent/uploads/sites/2/2022/02/pass_bg.png&phone=1234567890&email=test123@gmail.com&address=123 Main Street, Testville, CA 19001&surrounding=LACounty&website_name=The Site&website=https://google.com&link1_name=Link1Naming&link1=https://example1.com&link2_name=Link2Naming&link2=https://example2.com&monday=1-2pm&tuesday=2-3pm&wednesday=3-4pm&thursday=4-5pm&friday=5-6pm&saturday=6-7pm&sunday=7-8pm&facebook=https://facebook.com&twitter=https://twitter.com&instagram=https://instagram.com&linkedin=https://linkedin.com&yelp=https://yelp.com&google=https://google.com/maps&youtube=https://www.youtube.com/c/facebookapp/videos&more=This is a test more note<BR>with a secondary line<BR><a href='https://example.com'>LINK</a>&header1=line1&header2=line2&html=<iframe style='height:500px;' src='https://example.com' ></iframe>
Response
• SUCCESS:
o {"SUCCESS":"Card Created\/Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD TAGS
This endpoint is for managing the Card deployment section in the dashboard.
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-tags/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/sample_tag_import.csv
o If there is a match with TAG CUSTOM UNIQUE ID, the TAG NAME / DETAILS and CARD BACKSIDE CONTENT will update accordingly instead of creating a new record and all Card Holders who hold this card will have the Card updated.
o CARD BACKSIDE CONTENT follows the same guidelines as MORE in the Card Editor. It supports HTML A tags and line breaks.
o CARD BACKSIDE CONTENT NEXT follows the same guidelines as MORE in the Card Editor. It supports HTML A tags and line breaks. This field is enabled after the next scan or click of this tag and will alert the user the card has been updated. The CARD BACKSIDE CONTENT will become what was CARD BACKSIDE CONTENT NEXT and the CARD BACKSIDE CONTENT NEXT will then be cleared. This is designed for a single generic message evolving into a user specific content where 1 tag = 1 device such as a mailer.
o CARD BACKSIDE FTP CONTENT follows same concept as CARD BACKSIDE CONTENT except it will utilize FTP to derive content at time the card is generated on the phone for added security measures such as HIPPA data. FTP must be port 21. The file must be a text file name and located in the root directory of the given FTP.
o CARD BACKSIDE FTP CONTENT NEXT follows the same guidelines as CARD BACKSIDE CONTENT with the logic of CARD BACKSIDE CONTENT NEXT for next content.
o TAG META INFO follows the same guidelines as above; this field serves as additional optional meta information for the tag; can be serialized, JSON or text
Example
https://addthispass.com/api/card-tags/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD MESSAGES
This endpoint is for managing the Card messaging section in the dashboard.
Endpoint
Request Parameters (all required)
Request Parameters (all optional)
Example
Response
Endpoint
https://addthispass.com/api/card-push/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• push: (varchar) – 46 character limit
o value of the push line 1 (what shows on lock screen)
• holders: (int) – leave empty for all
o distribution tag ID (if you want to send to a particular tag only)
• message_preferences: (int) – leave empty for all
o alert preference ID (if you want to send to a particular alert segment)
------------------------------------------------------------------------------
• clear: (enum) – CARD IF CLEARING PUSH
o true
Request Parameters (all optional)
• push2: (varchar) – 46 character limit
o value of the push line 2 (what shows after a user opens push)
• push3: (varchar) – 46 character limit
o value of the push line 3 (what shows after a user opens push)
• thumbnail: (varchar) – if Card has a Banner Image, this option is unavailable
o URL of hosted image – must include http/s (be jpg/png/gif and less then 1MB)
• push_duration: (int)
o number of minutes for push to be visible
---------------------------------------------------------------------------------
• push_date: (date)
o date (2022-12-31)
• push_time: (time)
o timestamp (12:00)
• push_timezone: (enum)
o -7 (-12 hours)
o -6 (-11 hours) - Hawaii
o -5 (-10 hours)
o -4 (-9 hours) - Alaska
o -3 (-8 hours) - Pacific
o -2 (-7 hours) - Mountain
o -1 (-6 hours) - Central
o 0 (-5 hours) - Eastern
o 1 (-4 hours)
o 2 (-3 hours)
o 3 (-2 hours)
o 4 (-1 hours)
o 5 (+0 hours)
o 6 (+1 hours) - European
o 7 (+2 hours)
o 8 (+3 hours)
o 9 (+4 hours)
o 10 (+5 hours)
o 11 (+6 hours)
o 12 (+7 hours)
o -12 (+8 hours)
o -11 (+9 hours)
o -10 (+10 hours)
o -9 (+11 hours)
o -8 (+12 hours)
---------------------------------------------------------------------------------
Filtering by User Type:
• user_type: (enum)
o registered
o nonregistered
---------------------------------------------------------------------------------
Filtering by Registration Dates (assumes date/time is same as timezone above):
• filter_from_date: (date)
o date (2022-12-31)
• filter_from_time: (time)
o timestamp (12:00)
• filter_to_date: (date)
o date (2022-12-31)
• filter_to_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Phone Engagement (assumes date/time is same as timezone above):
• phone_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• phone_num: (int)
o number of desired instances
• phone_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• phone_date: (date)
o date (2022-12-31)
• phone_time: (time)
o timestamp (12:00)
-------------------------------------------------------------------------------
Filtering by Email Engagement (assumes date/time is same as timezone above):
• email_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• email_num: (int)
o number of desired instances
• email_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• email_date: (date)
o date (2022-12-31)
• email_time: (time)
o timestamp (12:00)
-------------------------------------------------------------------------------
Filtering by Address Engagement (assumes date/time is same as timezone above):
• directions_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• directions_num: (int)
o number of desired instances
• directions_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• directions_date: (date)
o date (2022-12-31)
• directions_time: (time)
o timestamp (12:00)
-------------------------------------------------------------------------------
Filtering by Website / Link 1 Engagement (assumes date/time is same as timezone above):
• link1_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link1_num: (int)
o number of desired instances
• link1_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link1_date: (date)
o date (2022-12-31)
• link1_time: (time)
o timestamp (12:00)
-------------------------------------------------------------------------------
Filtering by Link 2 Engagement (assumes date/time is same as timezone above):
• link2_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link2_num: (int)
o number of desired instances
• link2_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link2_date: (date)
o date (2022-12-31)
• link2_time: (time)
o timestamp (12:00)
-------------------------------------------------------------------------------
Filtering by Link 3 Engagement (assumes date/time is same as timezone above):
• link3_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link3_num: (int)
o number of desired instances
• link3_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• link3_date: (date)
o date (2022-12-31)
• link3_time: (time)
o timestamp (12:00)
--------------------------------------------------------------------------------
Filtering by Facebook Engagement (assumes date/time is same as timezone above):
• fb_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• fb_num: (int)
o number of desired instances
• fb_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• fb_date: (date)
o date (2022-12-31)
• fb_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Twitter Engagement (assumes date/time is same as timezone above):
• tw_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• tw_num: (int)
o number of desired instances
• tw_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• tw_date: (date)
o date (2022-12-31)
• tw_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Instagram Engagement (assumes date/time is same as timezone above):
• ig_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• ig_num: (int)
o number of desired instances
• ig_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• ig_date: (date)
o date (2022-12-31)
• ig_time: (time)
o timestamp (12:00)
----------------------------------------------------------------------------------
Filtering by LinkedIn Engagement (assumes date/time is same as timezone above):
• li_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• li_num: (int)
o number of desired instances
• li_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• li_date: (date)
o date (2022-12-31)
• li_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Yelp Engagement (assumes date/time is same as timezone above):
• yp_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• yp_num: (int)
o number of desired instances
• yp_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• yp_date: (date)
o date (2022-12-31)
• yp_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Google Business / Places Engagement (assumes date/time is same as timezone
above):
• gp_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• gp_num: (int)
o number of desired instances
• gp_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• gp_date: (date)
o date (2022-12-31)
• gp_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by YouTube Engagement (assumes date/time is same as timezone above):
• yt_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• yt_num: (int)
o number of desired instances
• yt_w_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• yt_date: (date)
o date (2022-12-31)
• yt_time: (time)
o timestamp (12:00)
---------------------------------------------------------------------------------
Filtering by Geofenced Address Engagement:
• distance_op: (enum)
o < (less than)
o <= (less than or equal to)
o = (exactly)
o >= (more than or equal to)
o > (more than)
• distance_num: (int)
o number of desired instances
• distance_address: (varchar)
o address as varchar
• distance_lat: (varchar)
o latitude
• distance_lon: (varchar)
o longitude
---------------------------------------------------------------------------------
• serial: (varchar)
o if you pass the device serial, you can send to a specific device (if not found nothing sends)
---------------------------------------------------------------------------------
Add a Redirect Destination to a Card Message (for 'Mobile Wallet' ONLY):
• redirect: (enum)
o 1 (opens the Card in Wallet -- default setting)
o 2 (opens the Card then redirects to URL)
o 3 (opens 'Mobile Wallet' then redirects to URL)
• redirect_url: (varchar)
o must include 'http/https'
Example
https://addthispass.com/api/card-push/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z&push=First%20Line&holders=&message_preferences=&push2=Second%20Line&push3=Third%20Line&push_duration=2&push_date=2022-11-14&push_time=15:05&push_timezone=0&thumbnail=https://mobilewallet.cards/more/wp-content/uploads/sites/2/2022/02/pass_bg.png
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
VIEW CARD MESSAGES
This endpoint is for viewing the Card messaging section in the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-messaging-details/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id
Example
https://addthispass.com/api/card-messaging-details/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2XDy6g==
Response
• SUCCESS:
o {
"STATUS": "Sent To 3488 Devices",
"DISTRIBUTION TAG ID": "186257",
"ALERT PREFERENCE ID": "103",
"DATE/TIME": "01/23/24 09:51 am",
"EXPIRATION": "65",
"TIMEZONE": "(-5 hours) - Eastern",
"LINE 1": "Line 1 Push",
"LINE 2": "Line 2 Push",
"LINE 3": "Line 3 Push",
"THUMBNAIL": "https://admin.mobilewallet.cards/pass/media/XXX/XXXXX/thumbnail.png",
"REDIRECT": 2,
"REDIRECT URL": "https://google.com",
"TOTAL VIEWS": 9,
"UNIQUE VIEWS": 3
}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD GEOFENCES
This endpoint is for managing the Card geofencing section in the dashboard.
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-locations/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/sample_location_import.csv
o If there is a match with LOCATION LATITUDE and LOCATION LONGITUDE, the MESSAGE, STATUS, (SUPPRESSION (varchar for minutes) & REDIRECT/ACTION (int for option/varchar for url include http) are for Mobile Wallet ONLY) will update accordingly instead of creating a new record.
Example
https://addthispass.com/api/card-locations/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD BEACONS
This endpoint is for managing the Card Bluetooth beacons section in the dashboard.
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-beacons/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/sample_beacon_import.csv
o If there is a match with MAJOR, MINOR and UUID, the MESSAGE, STATUS, (SUPPRESSION (varchar for minutes) & REDIRECT/ACTION (int for option/varchar for url include http) are for Mobile Wallet ONLY) will update accordingly instead of creating a new record.
Example
https://addthispass.com/api/card-beacons/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
VIEW CARD
GEOFENCES & BEACONS
This endpoint is for viewing the Card geofences and Bluetooth beacons.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-auto-messaging-details/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id
• type: (enum)
o geofences
o beacons
Example
https://addthispass.com/api/card-auto-messaging-details/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2XDy6g==&type=geofences
Response
• SUCCESS:
o {
"LOCATION": "123 William Street, New York, NY, USA",
"LOCATION LATITUDE": "40.7094756",
"LOCATION LONGITUDE": "-74.0072955",
"MESSAGE": "Welcome to the store",
"STATUS": "disabled",
"SUPPRESSION": "5",
"REDIRECT": "2",
"REDIRECT URL": "https://google.com"
}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD GENERIC BARCODES
This endpoint is for managing the Card 'Administrative generated' barcodes from the barcodes section in the dashboard.
Endpoint
Request Parameters (all required)
Request Parameters (all optional)
Example
Response
Endpoint
https://addthispass.com/api/card-barcode/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• barcode: (varchar)
o value of the barcode
• barcode_alt: (varchar)
o textual display under barcode (can be set to nothing)
-------------------------------------------------------
• clear: (enum) – CARD IF CLEARING BARCODE
o true
Request Parameters (all optional)
• barcode_date: (date)
o date (2022-12-31)
• barcode_time: (time)
o timestamp (12:00)
• barcode_timezone: (enum)
o -7 (-12 hours)
o -6 (-11 hours) - Hawaii
o -5 (-10 hours)
o -4 (-9 hours) - Alaska
o -3 (-8 hours) - Pacific
o -2 (-7 hours) - Mountain
o -1 (-6 hours) - Central
o 0 (-5 hours) - Eastern
o 1 (-4 hours)
o 2 (-3 hours)
o 3 (-2 hours)
o 4 (-1 hours)
o 5 (+0 hours)
o 6 (+1 hours) - European
o 7 (+2 hours)
o 8 (+3 hours)
o 9 (+4 hours)
o 10 (+5 hours)
o 11 (+6 hours)
o 12 (+7 hours)
o -12 (+8 hours)
o -11 (+9 hours)
o -10 (+10 hours)
o -9 (+11 hours)
o -8 (+12 hours)
• barcode_duration: (int)
o number of minutes for barcode to be visible
Example
https://addthispass.com/api/card-barcode/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z&barcode=123123&barcode_alt=Scan%20Me&barcode_date=2022-10-20&barcode_time=09:58&barcode_duration=60
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD DYNAMIC BARCODES
This endpoint is for managing the Card 'Registration value generated' barcodes.
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-barcode-dynamic/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/sample_barcode_import.csv
o If there is a match with Barcode, the BARCODE and STATUS will update accordingly instead of creating a new record – If set to disabled, the barcode will automatically disappear from an expire from a card holder
Example
https://addthispass.com/api/card-barcode-dynamic/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD SPECIFIC (BARCODES & MESSAGES)
This endpoint is for managing the Card specific barcodes and accompanying an optional message .
Endpoint
Request Parameters (all required)
Request Parameters (optional)
Example
Response
Endpoint
https://addthispass.com/api/card-barcode-push/
Request Parameters (all required)
• key: (static varchar) o IG)(V{Y^_12317EF6{{a345}^Gga9z • referral_id: (int) o Partner Approval code • account_key: (varchar) o for the Card Account • card_id: (varchar) o card_id to make edits
• lookup: (enum) o phone (registered phone)
o email (registered email)
o address (registered address)
o other (registered other)
o serial (device serial)
• details: (varchar) o value to use for the above lookup
• barcode: (varchar) o this is the value to be converted into a barcode
• barcode_alt: (varchar) o this is the message that shows under the barcodeNote:
• If push is not set in endpoint '&push=', no message will be sent• If '&barcode_ignore=true' is appended, this will not set (or) unset the barcode
Request Parameters (optional)
• push: (varchar) o this is push line 1 that will be sent with barcode
• push2: (varchar) o this is push line 2 that will be sent with barcode
• push3: (varchar) o this is push line 3 that will be sent with barcode
Example
https://addthispass.com/api/card-barcode-push/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z&lookup=email&details=test@example.com&barcode=123456789&barcode_alt=Here+Is+Your+Coupon:+123456789
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD HOLDER DATA EXPORT
This endpoint is for exporting Card Holder details from the engagement section of the dashboard.
Endpoint
Request Parameters (all required)
Request Parameters (optional but all required when utilizing)
Example
Response
Endpoint
https://addthispass.com/api/card-engagement/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request Parameters (optional but all required when utilizing)
• from_date: (timestamp – must be same as timezone setting)
o timestamp (2022-12-01 00:00:00)
• to_date: (timestamp – must be same as timezone setting)
o timestamp (2022-12-31 23:59:59)
• filter_by: (enum)
o signup – when the Card was first registered
o updated – when the Card was last updated
o phone – when the 'phone number' was last clicked
o email – when the 'email address' was last clicked
o address – when the 'address info' was last clicked
o website – when the 'website link – link 1' was last clicked
o link1 – when the 'additional link 1 – link 2' was last clicked
o link2 – when the 'additional link 2 – link 3' was last clicked
o facebook – when the 'facebook link' was last clicked
o twitter – when the 'twitter link' was last clicked
o instagram – when the 'instagram link' was last clicked
o linkedin – when the 'linkedin link' was last clicked
o yelp – when the 'yelp link' was last clicked
o google – when the 'google link' was last clicked
o youtube –when the 'youtube link' was last clicked
-------------------------------------------------------------
• fields: (enum) - this will allow you to return select device data fields (comma separated) - designed for fast and large lookups - replaces all fields with selected
o Example: &fields=device_name,device_email
o device_name - this is for the registered 'Name' value
o device_email - this is for the registered 'Email' value
o device_phone - this is for the registered 'Phone' value
o device_address - this is for the registered 'Address' value
o device_other - this is for the registered 'Other' value
o submitted - this is whether this Card was registered
o device_onetime_meta - this is for the initial meta info on Card add
o device_meta - this is for the meta info
o device_suspended - this is the Card's suspended status
o device_preferences - these are the preferences this device belongs too
o device_status - this is the Card's wallet status
o first_signup - this is when the Card was added to the Wallet
Example
https://addthispass.com/api/card-engagement/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2olZ
Response
• SUCCESS:
o will output JSON results
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD STATISTICS EXPORT
This endpoint is for exporting Card statistics from the engagement section of the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-statistics/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Example
https://addthispass.com/api/card-statistics/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2olZ
Response
• SUCCESS:
o will output JSON results
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD STATISTICS RESET
This endpoint is for reseting the Card statistics from the engagement section of the dashboard.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-statistics-reset/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• asset_type: (enum)
o d_phone (phone)
o d_email (email)
o d_address (directions)
o d_web1 (web 1 – aka commonly used as the website)
o d_web2 (url 2)
o d_web3 (url 3)
o d_fb (Facebook)
o d_tw (Twitter)
o d_ig (Instagram)
o d_li (LinkedIn)
o d_yp (Yelp)
o d_gp (Google)
o d_yt (YouTube)
Example
https://addthispass.com/api/card-statistics-reset/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2olZ&asset_type=d_phone
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2odE"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD TAG STATISTICS EXPORT
This endpoint is for exporting Card distribution tag statistics.
Endpoint
Request Parameters (all required)
Request Parameters (all optional – pick one or the other)
Example
Response
Endpoint
https://addthispass.com/api/card-tag-statistics/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request Parameters (all optional – pick one or the other)
• tag_id: (int)
o if you don’t want all records, you can request specific tag details
• tag_unique_id: (varchar)
o if you don't want all records, you can request specific tag details
OR RUN BY ACTIVITY (PROMPTS/ADDS) - Both Below Are Required:
• tag_activity_start: (datetime)
o datetime should be same as Card timezone, ex: 2024-08-23+16:40:00
• tag_activity_end: (datetime)
o datetime should be same as Card timezone, ex: 2024-08-23+16:50:00
Example
https://addthispass.com/api/card-tag-statistics/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2olZ
Response
• SUCCESS:
o will output JSON results
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD LOOKUP
This endpoint is for locating a specific Card by a Registration value to get the unique Serial number.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-update/
Request Parameters (all required)
• lookup: (varchar)
o this with be the key value pair that was set for device install
§ For example: &O-test=12345 - Lookup would be: O-test=12345
• account_key: (varchar)
o for the Card Account (these must be set)
• card_id: (varchar)
o for the Card ID (these must be set)
Example
https://addthispass.com/api/card-update/?lookup=O-test=12345&account_key=22fkXw==&card_id=0Yj1
Response
• SUCCESS:
o {"SERIAL":" UauFDiuendXuBix-1676040185_915_","DEVICE INSTALL CONTENT":{"key":"O-test","value":"12345"},"WALLET":"thewalletgroup:\/\/"}
• ERROR:
o {"ERROR":"Domain Not Authorized."}
o {"ERROR":"Incorrect Parameters."}
o {"ERROR":"Incorrect Pass Details."}
o {"ERROR":"Missing Info."}
o {"ERROR":"Inaccurate Data."}
o {"ERROR":"Incorrect Account Details."}
o {"ERROR":"Device Invalid."}
CARD CONTENT & META UPDATE
This endpoint is for updating a specific Card (its content or meta details) by a unique Serial number. In order to update a Card's content or meta, the referring domain(s) must also be 'Whitelisted'. They can be registered in the Dashboard 'Designer' section, on the Card backside, at the very bottom.
Endpoint
Request Parameters (all required)
View Meta Example
Response
Update Meta Example
Response
Endpoint
https://addthispass.com/api/card-update/
Request Parameters (all required)
• serial: (varchar)
o for a specific Card Holder (must use the 'Card Lookup' endpoint)
o Note, this could be collected when a Card Holder clicks on a link with a serial appended: https://example.com?serial={{SERIAL}}
• account_key: (varchar)
o for the Card Account (these must be set)
• card_id: (varchar)
o for the Card ID (these must be set)
• det: (enum)
o card
§ this is additional content that shows on the Card backside
o meta
§ this is a internal meta field for storing Card information
• act: (enum)
o view
§ this is for viewing the 'det' attribute above
o edit
§ this is for updating the 'det' attribute above
----------------------------------------------------------------------------------------
• if your updating where 'det=meta' and 'act=edit' - you can pass multiple fields at once:
o content (varchar) – this can be a string or serialized object
o pass '&update=true' to have device automatically update
§ if the above is appended you can also send an optional push to the device
o using '&push=XXX' for push line 1
o using '&push2=XXX' for push line 2
o using '&push3=XXX' for push line 3
-----------------------------------------------------------------
o If you are also updating the predefined registration fields:
§ name (varchar) - Registration field 'Name'
§ email (varchar) - Registration field 'Email'
§ phone (varchar) - Registration field 'Phone'
§ address (varchar) - Registration field 'Address'
§ other (varchar) - Registration field 'Other'
§ submitted (enum) - indicates if form was completed (yes/no) - if not set it defaults to 'no'
------------------------------------------------------------------------------------------
§ If you want to update the Cards location:
§ lat (varchar) - Card latitude
§ lon (varchar) - Card longitude
View Meta Example
https://addthispass.com/api/card-update/?serial=UauFDiuendXuBix-1676040185_915_&det=meta&act=view&account_key=22fkXw==&card_id=0Yj1
Response
• SUCCESS:
o {"DEVICE CONTENT":"test","WALLET":"thewalletgroup:\/\/"}
• ERROR:
o {"ERROR":"Domain Not Authorized."}
o {"ERROR":"Incorrect Parameters."}
o {"ERROR":"Incorrect Pass Details."}
o {"ERROR":"Missing Info."}
o {"ERROR":"Inaccurate Data."}
o {"ERROR":"Incorrect Account Details."}
o {"ERROR":"Device Invalid."}
Update Meta Example
https://addthispass.com/api/card-update/?serial=UauFDiuendXuBix-1676040185_915_&det=meta&act=edit&content=test&account_key=22fkXw==&card_id=0Yj1
Response
• SUCCESS:
o {"SUCCESS":"Device Updated.","WALLET":" thewalletgroup:\/\/"}
• ERROR:
o {"ERROR":"Domain Not Authorized."}
o {"ERROR":"Incorrect Parameters."}
o {"ERROR":"Incorrect Pass Details."}
o {"ERROR":"Missing Info."}
o {"ERROR":"Inaccurate Data."}
o {"ERROR":"Incorrect Account Details."}
o {"ERROR":"Device Invalid."}
CARD UNIQUE MESSAGE UPDATES
This endpoint is for sending unique push message to specific Cards by corresponding Registration values.
Endpoint
Request Parameters (all required)
Request Parameters (all optional)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-mass-push/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request Parameters (all optional)
• push_date: (date)
o date (2022-12-31)
• push_time: (time)
o timestamp (12:00)
• push_timezone: (enum)
o -7 (-12 hours)
o -6 (-11 hours) - Hawaii
o -5 (-10 hours)
o -4 (-9 hours) - Alaska
o -3 (-8 hours) - Pacific
o -2 (-7 hours) - Mountain
o -1 (-6 hours) - Central
o 0 (-5 hours) - Eastern
o 1 (-4 hours)
o 2 (-3 hours)
o 3 (-2 hours)
o 4 (-1 hours)
o 5 (+0 hours)
o 6 (+1 hours) - European
o 7 (+2 hours)
o 8 (+3 hours)
o 9 (+4 hours)
o 10 (+5 hours)
o 11 (+6 hours)
o 12 (+7 hours)
o -12 (+8 hours)
o -11 (+9 hours)
o -10 (+10 hours)
o -9 (+11 hours)
o -8 (+12 hours)
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/mass_messaging_import.csv
o Row 1 (key) must be a valid registration field:
§ NAME, EMAIL, PHONE, ADDRESS, OTHER, SERIAL or any of the below:
§ meta-json-O-{{KEY}} : this will allow you to query a KEY / VALUE pair by the Card’s meta (if Card’s meta is setup as a JSON object)
§ meta-equal-O-{{KEY}} : this will allow you to specifically find by a KEY / VALUE pair by the Card’s meta
§ meta-like-O-{{KEY}} : this will allow you to utilize a LIKE clause for a KEY / VALUE pair by the Card’s meta
§ onetime-O-{{KEY}} : this will allow you to query a KEY / VALUE pair by the Card’s one-time meta
o If a user registration has input that matches the row 1 key, the PUSH, PUSH2 and PUSH3 will be sent to that user’s device.
Example
https://addthispass.com/api/card-mass-push/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z&push_date=2022-12-03&push_time=23:46&push_timezone=0
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD DEVICE CONTENT UPDATE
This endpoint is for uploading pre-approved Registration values so Card Holders after Registration can be auto-approved if a match is found. (this is for Cards that are automatically 'Suspended')
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-device-content/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/device_content_import.csv
o Row 1 (key) must be a valid registration field: NAME, EMAIL, PHONE, ADDRESS or OTHER
o If a user registration has input that matches the row 1 key, the CONTENT and/or FTP CONTENT will update accordingly
Example
https://addthispass.com/api/card-device-content/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD REGISTRATION AUTO APPROVAL
This endpoint is for sending unique push message to specific Cards by corresponding Registration values.
Endpoint
Request Parameters (all required)
Request (Post) Parameters (required)
Example
Response
Endpoint
https://addthispass.com/api/card-approval/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
Request (Post) Parameters (required)
• import_file: (must be post name)
o file must be in a (.csv)
o file must include the top headers (from sample)
§ https://admin.mobilewallet.cards/dashboard/manage/sample_auto_approval_import.csv
o UNQUE ROW ID must be unique for all rows (this acts as a KEY)
o If there is a match with UNQUE ROW ID (KEY), the NAME, EMAIL, PHONE, ADDRESS and/or OTHER will update accordingly instead of creating a new record – If disabled, the row will no longer be used in registration validation and is considered deleted
o Adding an asterisk (*) after NAME, EMAIL, PHONE, ADDRESS and OTHER will make that column be a required registration value (IE. EMAIL*)
Example
https://addthispass.com/api/card-approval/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=222Z
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"222Z"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}
CARD SUSPENSION
This endpoint is for suspending and unsuspending Card Holders by serial or in bulk.
Endpoint
Request Parameters (all required)
Example
Response
Endpoint
https://addthispass.com/api/card-suspension/
Request Parameters (all required)
• key: (static varchar)
o IG)(V{Y^_12317EF6{{a345}^Gga9z
• referral_id: (int)
o Partner Approval code
• account_key: (varchar)
o for the Card Account
• card_id: (varchar)
o card_id to make edits
• device: (varchar)
o can be either be a '{serial number}' of a specific Card Holder or 'all' for everyone
• suspend: (enum)
o 'yes' will suspend
o 'no' will unsuspend
Example
https://addthispass.com/api/card-suspension/?key=IG)(V{Y^_12317EF6{{a345}^Gga9z&referral_id=2560&account_key=2XEzmg==&card_id=2X9WmFE==&device=o8zxdYxpd-1723979103_17682_&suspend=yes
Response
• SUCCESS:
o {"SUCCESS":"Card Updated.","CARD":"2X9WmFE==","DEVICE":"o8zxdYxpd-1723979103_17682_","STATUS":"Suspended"}
• ERROR:
o {"ERROR":"Not Valid Key."}
o {"ERROR":"Not Valid Referral ID."}
o {"ERROR":"Not Valid Account Key."}
o {"ERROR":"Missing Info."}