Documentation

Change history

Suggest Edits

The following table lists the documentation updates:

DateTicket NumberChange
7/14/2025API_659🚧 Coming soon Added the ability to update the low balance alerts via PATCH /customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID}. This helps improve the management of low balance alerts through the API. See how you can Update a low balance alert for a customer account.
7/11/2025API-690🐞 Fixed the response from tc-web-hooks was updated to include the expiresAt field as expected.
7/10/2025API-627🚧 Coming soon Added validation of delivery methods based on the attributes associated with a UTID. For example: UTID=U1234 has the attributes= (NONE, EMAIL, PHONE, and EMBEDDED). When the user resends the reward with deliveryMethod=PHONE, the system will allow the resend because PHONE is an eligible method for this UTID. When the user resends the reward with deliveryMethod=ADDRESS, the system will reject the resend because ADDRESS is not among the UTID's eligible delivery method.
7/8/2025? RL-3938🆕 Added customUrl as a URL reward type in credential types. customeUrl is a personalized or branded link that takes the user to a reward landing page. See Get credential types.
7/7/2025API-660🚧 Coming soon Added the ability to retrieve a list of low balance alerts for a customer account by calling GET /customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance endpoint. This enhancement improves the monitoring and management of account balances through the API. See Get a list of all low balance alerts.
7/7/2025API-539🆕 Introduced the APICredentials webhook event under PLATFORM category to notify users when the API credentials are created, viewed, updated, or deleted. This improves the security and real-time monitoring of API. See Platform category events.
7/1/2025API-665🚧 Coming soon Added that ability to search the catalog for specific attribute. See Get all items in the platform catalog.
7/1/2025API-653🚧 Coming soon Enhanced the order processing logic: previously, the system determined if an order was for physical delivery based on the presence of a recipient address. The new logic requires the API to use the deliveryMethod field instead. See POST orders for when you create an order.
6/27/2025API-651🆕 Enhanced the "campaign" field to accept any character (including special characters), similar to the NOTES and MESSAGE fields. The field length is set to 1024 characters. See Orders and Line Items.
6/27/2025API-614🚧 Coming soon Added smsMessageBody to POST {URI}/emailTemplates and PATCH {URI}/emailTemplates/{etid} endpoints to be able to create an SMS message body for SMS delivery as an option. See Create a new email template and Update details for a specific email template.
6/26/2025API-661🚧 Coming soon Created the ability to get a specific low balance alert via the API by using GET {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/ {balanceAlertID}. See Get a low balance alert for a customer account.
6/24/2025API-662🚧 Coming soon Created the ability to delete a specific low balance alert via the API by using DELETE {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID}. See Delete a low balance alert for a customer account.
5/14/2025-Added service account (username and password) as additional security level to OAuth connection. As of May 14, 2025, the Tango API will require client ID, client secret, service account username, and service account password to generate the access token when using OAuth. See Use OAuth for more secure connection.
5/7/2025API-328Added Transaction eventType to the Account category in supported webhooks. Webhook events are sent when funds are added, removed, or transferred to or from your Tango account. See about Transition.
5/7/2025API-573Added rewardType query parameter to GET {URI}/catalogs to enhance querying flexibility for users who access Tango catalog. See Get all items in the platform catalog.
5/7/2025API-271Added the new GET {URI}/webhooks/eventtypes endpoint to webhooks to list all event types offered in the system for subscription. See Get all subscription event types.
5/1/2025API-437Updated recipient's physical address fields to include new characters such as &, %, #, @ in the POST {URI}/orders. See Create an order under a specific account.
5/7/2025API-573Added rewardType query parameter to GET {URI}/catalogs to enhance the catalog search. See Get all items in the platform catalog.
5/7/2025API-564🚧 Coming soon Modified POST {URI}/orders/{referenceOrderID}/resends to allow for SMS delivery when resending a specific order by adding newDeliveryMethod and newMobile as body parameters. We will support different delivery methods including NONE, EMAIL, PHONE, and EMBEDDED. See Resend a specific order.
5/7/2025API-565🚧 Coming soon Added the ability to deliver rewards via SMS by adding deliveryMethod to POST {URI}/orders . See Create an order under a specific account.
5/7/2025API-562🚧 Coming soon Added SMS parameter to GET {URI}/orders payload to include deliveryMethod , recipientMobileNumber , and deliveryStatus in the payload. This change improves the flexibility and options for order delivery. See Get a list of orders placed on this platform.
5/7/2025API-563🚧 Coming soon Added SMS parameters to GET {URI}/lineItems payload to include deliveryMethod , recipientMobileNumber , and deliveryStatus in the payload. This change enhances the delivery options available to users and retrieves and filters the information about all line items ordered on the platform. See Get line items.
4/30/25API-347Added externalRefID to the POST {URI}/creditCardDeposits endpoint as an idempotent key support for funding cross reference and to prevent accidental funding duplication. See Fund an account .
4/30/25API-389Added a body parameter: externalRefID to POST {URI}/transferFunds endpoint for funding cross reference and to prevent accidental funding duplication. See Transfer funds .
4/17/2025API-540Added RewardStatus event type under Reward category in supported webhooks that sends notifications every time a reward status is changed. See Reward status.
3/27/2025API-363, API-549Emojis are not accepted for displayName or any text entry. See POST {URI}/customers in Create a new customer and POST {URI}/customers/{customerIdentifier}/accounts in Create an account under a specific customer.
3/26/2025-Added the new terminology for product release. See Release terminology in our Glossary.
3/26/2025-(Closed Release) Added Line item delivery status for physical gift cards.
3/21/2025-(Closed Release) Improved OAuth 2.0 for more secure connection. You need four pieces of information to acquire a token: the client ID, client secret, service account username, and service account password. See Secure your connection with Tango API.
3/18/2025API-542Added i18nkey codes and their error messages to provide more specific error codes.
3/3/2025API-519We now accept Australian dollars (AUD) for Global Choice Link. To create an AUD account, see POST {URI}/customers/{customerIdentifier}/accounts. Other accepted currencies are CAD, EUR, GBP, or USD.
2/2025API-532🆕 Changed "Get line item" to Get details for a specific line item.
2/2025API-482🆕 Included error responses for Choice Products endpoints. See Manage Choice products endpoints.
2/2025API-481🆕 Included error responses for Credential Types endpoints. See Get credential types.
2/2025API-480🆕 Included error responses for Exchange Rates endpoints. See Get exchange rates.
2/2025API-479🆕 Included error responses for Email Templates endpoints. See Manage email templates endpoints.
2/2025API-477🆕 Included error responses for Orders endpoints. See Manage Orders endpoints.
2/2025API-476🆕 Included error responses for Catalog endpoints. See Get all items in the platform catalog.
2/21/2025API-474🆕 Included error responses for Fund endpoints. See Manage funds endpoints.
2/18/2025API-506Added a list of reasons for freeze, unfreeze, cancel, and reissue line items. Use GET {URI}/lineItems/reasonCodes to get the reason codes. See Get all reason codes.
2/18/2025API-214Added pagination to the list of customers when you use GET {URI}/customers. with this query parameter, you can receive a paginated payload helping you manage the results more effectively. See Get a list of all customers .
2/18/2025API-218Added pagination to the list of credit cards when you use GET {URI}/creditCards. with this query parameter, you can receive a paginated payload helping you manage the results more effectively. See List all credit cards registered on this platform.
2/18/2025API-451Added the ability to update line item parameters (purchase order number, campaign, and order notes) using PATCH /lineItems/ {referenceLineItemID}.
2/18/2025API-213Added query parameters to GET {URI}/customers. Filter by items such as display name, status, account number, and more. See Get a list of all customers .
2/18/2025API-462
API-463
API-464
API-508		Added capabilities to freeze, unfreeze, cancel, and reissue line items:
-To cancel, callPOST /lineItems/{referenceLineItemID}/cancel.
-To freeze, call POST /lineItems/{referenceLineItemID}/freeze.
-To unfreeze, call POST /lineItems/{referenceLineItemID}/unfreeze.
-To reissue, call POST /lineItems/{referenceLineItemID}/reissue.
12/3/2024API-422IncludedrewardStatus in the payload of GET {URI}/lineItems to indicates whether a reward is frozen or active.
12/3/2024API-224IncludedisExpirable in the payload of GET {URI}/choiceProducts/{choiceProductUtid}/catalog and GET {URI}/catalogs to indicate whether or not the gift card has a expiry date. isExpirable is a boolean with true or false value.
10/16/2024-Updated OAuth 2.0 with a note: "When you deactivate a client credential, all active tokens for this client will become invalid and your integration will be broken. Deactivation cannot be reversed." OAuth 2.0 is currently on a limited release.
9/30/2024-Added account statuses such as Active, Inactive, etc. to the webhook event: AccountStatus.
8/15/2024-Deprecated credentials and added a note to use credentialList instead.
4/8/2024API-373Added a new endpoint to filter your catalog for your recipients based on country and currency. Use the GET /rewardCountries endpoint to determine the preferred currency.
3/25/2024-Added a new parameter to use with POST {URI}/orders/{referenceOrderID}/resends for when you are resending an order.
3/15/2024API-211Improved the results of GET {URI}/accounts by adding more query parameters.
2/20/2024API-241Added ability to categorize each brand into industry-standard categories within the Tango catalog and group/filter the brand in your custom catalog display. See categoryIds.
2/13/2024API-334Added fundingNotification body parameter to POST {URI}/customers/{customerIdentifier}/accounts endpoint to be able to add 1 to 5 email addresses to your account when crating an account. See Create an account under a specific customer.
Added fundingNotification body parameter to PATCH {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier} endpoint to be able to add 1 to 5 email addresses to your account when updating an account. See Update an account under a specific customer.
2/8/2024API-345Improved the results of GET {URI}/creditCards by adding optional query parameters under funding account.
2/8/2024API-338Added currency type. Use the currencyCode body parameter with POST {URI}/customers/{customerIdentifier}/accounts to be able to create an account for a specific customer in any of these supported currencies: CAD, EUR, GBP, and USD. See Create an account under a specific customer.
1/29/2024API-240Added the ability to transfer funds from one account to another account of the same currency using GET {URI}/transferFunds.
2023
10/23/2023API-269Added GET /webhooks/{webhookId}/events?fromRevision={fromRevision}&toRevision={toRevision}&maxResultsint32={maxResultsint32} to receive all past event notifications up to three months.
* This feature is available in limited release, contact your Customer Success Manager (CSM) or [email protected] for more information.
10/17/2023API-270Added POST /webhooks/{webhookId}/replay?fromRevision={fromRevision}&toRevision={toRevision} to redeliver past webhook event notifications up to Three months. Notifications older than three months are not retrievable.
* This feature is available in limited release, contact your Customer Success Manager (CSM) or [email protected] for more information.
10/12/2023API-293Added GET {URI}/choiceProducts/{choiceProductUtid}/catalog to get the content of a Tango Choice catalog. You must have access to the Catalog to see the content.
10/12/2023API-294 You can get all available Choice Products in your Tango catalog using GET {URI}/choiceProducts to returns utid.
10/12/2023API-313Added GET {URI}/choiceProducts/{utid} to return the details for a specific Choice Product on your Tango platform.
10/11/2023API-320Added the ability to set a specific expiration date, such as 12/31/24, for a Promo Link at the time of order with Tango API instead of setting the expiration date as x days from the time of issuance. See the Promo Link acceptance criteria .
10/7/2023API-306Categories have a Universal Unique Identifier (UUID). You can filter a catalog by category using GET {URI}//brandCategories.
10/5/2023API-305Added the ability to order a Printed Reward Link using GET {URI}/lineItems when you Get a list of line items and GET {URI}/lineItems/{referenceLineItemID} when you Get details for a specific line item.
9/28/2023API-290Added the ability to modify the recipient address object to be included in all returning payloads of line items, as well as in any query parameters that can filter and search the recipient information.
9/27/2023API-304Added ptid to GET {URI}/ordersso you can get the list of Printed Reward Link orders.
9/26/2023API-303Added ptid to POST {URI}/orders so you can create Printed Reward Link orders.
9/15/2023API-295Added orderNotes GET {URI}/lineItems to see your order notes in both API and in the Tango portal line items history.
9/15/2023API-291Added purchaseOrderNumber to order and line items. You are now able to include a PO Number when creating an order.
8/18/2023API-282Added filters for one or more currencies when using the exchange rate endpoint.
6/16/2023Added OAuth authentication.
5/1/2023Added query parameters to "Get a list of Orders" and added pagination to "Get a list of Accounts".
2022
12/22/2022Exposed the GET /credentialtypes endpoint on the Test Console.
12/21/2022Added line items endpoints:

- GET {URI}/lineItems to get a list of line items in the platform.
- GET {URI}/lineItems/{referenceLineItemID}to get details for a specific line item.
- POST {URI}/lineItems/{referenceLineItemId}/resends to resend a specific line item.
8/23/2021Added GET /catalogs endpoint filters for utid, brandKey, currencyCode and country.
1/14/2021Added API Reference to primary drop down.
7/15/2019Added Glossary to the API documentation. (work in progress)
11/29/2018Removed non-active cards from GET creditCards default response. Must use "?showInactive=true" to see inactive cards.
11/1/2018Added Managing Email Templates for new API endpoints.
8/6/2018Added note to clarify 4 digit security code require for Amex for test environment funding.
7/19/2018Added credentialType to improve reward credential parsing.
4/18/2018Added XSS and malicious behavior prevention note.
4/12/2018Added SSL cert examples.
4/6/2018Added email receipts information in Funding.
3/29/2018Returned ETID in the API order response. Without a custom template defined, Tango default template ID: E000000 is returned.
3/29/2018Included i18nKey in error responses which serves as a unique error code to facilitate international translations.
2/28/2018Added clarification regarding how "Pending funding" status works.
Provided $5.55 and $6.55 test amounts in sandbox.
1/23/2018Updated: Group in Tango portal is calledCustomer in API.

Updated 2 days ago

© 2025 Tango API are provided by Tango, a division of BHN, Inc.