TalonOne 10.0.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package TalonOne --version 10.0.0
                    


                    

                
NuGet\Install-Package TalonOne -Version 10.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="TalonOne" Version="10.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="TalonOne" Version="10.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="TalonOne" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add TalonOne --version 10.0.0
                    


                    

                
#r "nuget: TalonOne, 10.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=TalonOne&version=10.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=TalonOne&version=10.0.0
                    


                            Install as a Cake Tool

Talon.One C# SDK

This SDK supports all of the operations of Talon.One's Integration API and Management API.

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using TalonOne.Api;
using TalonOne.Client;
using TalonOne.Model;

Determining the base URL of the endpoints

The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at https://yourbaseurl.talon.one, the URL for the Update customer session endpoint is https://yourbaseurl.talon.one/v2/customer_sessions/{Id}.

Getting started

Integration API

The following code shows an example of using the Integration API:

using System.Collections.Generic;
using System.Diagnostics;
using TalonOne.Api;
using TalonOne.Client;
using TalonOne.Model;

namespace Example
{
    public class Example
    {
        public static void main()
        {
            // Configure BasePath & API key authorization: api_key_v1
            var integrationConfig = new Configuration {
                BasePath = "https://yourbaseurl.talon.one", // No trailing slash!
                ApiKey = new Dictionary<string, string> {
                    { "Authorization", "e18149e88f42205432281c9d3d0e711111302722577ad60dcebc86c43aabfe70" }
                },
                ApiKeyPrefix = new Dictionary<string, string> {
                    { "Authorization", "ApiKey-v1" }
                }
            };

            // ************************************************
            // Integration API example to send a session update
            // ************************************************

            // When using the default approach, the next initiation of `IntegrationApi`
            // could be using the empty constructor
            var integrationApi = new IntegrationApi(integrationConfig);
            var customerSessionId = "my_unique_session_integration_id_2";  // string | The custom identifier for this session, must be unique within the account.

            // Preparing a NewCustomerSessionV2 object
            NewCustomerSessionV2 customerSession = new NewCustomerSessionV2 {
                ProfileId = "PROFILE_ID",
                CouponCodes = new List<string> {
                    "Cool-Stuff-2020"
                },
                CartItems = new List<CartItem> {
                    new CartItem(
                        name: "Hummus Tahini",
                        sku: "hum-t",
                        quantity: 1,
                        price: (decimal)5.5,
                        category: "Food"
                    ),
                    new CartItem(
                        name: "Iced Mint Lemonade",
                        sku: "ice-mn-lemon",
                        quantity: 1,
                        price: (decimal)3.5,
                        category: "Beverages"
                    )
                }
            };

            // Instantiating an IntegrationRequest object
            IntegrationRequest body = new IntegrationRequest(
                customerSession
                // Optional list of requested information to be present on the response.
                // See src/TalonOne/Model/IntegrationRequest#ResponseContentEnum for full list of supported values
                // new List<IntegrationRequest.ResponseContentEnum> {
                //     IntegrationRequest.ResponseContentEnum.CustomerSession,
                //     IntegrationRequest.ResponseContentEnum.CustomerProfile
                // }
            );

            try
            {
                // Create/update a customer session using `UpdateCustomerSessionV2` function
                IntegrationStateV2 response = integrationApi.UpdateCustomerSessionV2(customerSessionId, body);
                Debug.WriteLine(response);

                // Parsing the returned effects list, please consult https://developers.talon.one/Integration-API/handling-effects-v2 for the full list of effects and their corresponding properties
                foreach (Effect effect in response.Effects) {
                    switch(effect.EffectType) {
                        case "setDiscount":
                            // Initiating right props instance according to the effect type
                            SetDiscountEffectProps setDiscountEffectProps = (SetDiscountEffectProps) Newtonsoft.Json.JsonConvert.DeserializeObject(effect.Props.ToString(), typeof(SetDiscountEffectProps));

                            // Access the specific effect's properties
                            Debug.WriteLine("Set a discount '{0}' of {1:00.000}", setDiscountEffectProps.Name, setDiscountEffectProps.Value);
                            break;
                        // case "acceptCoupon":
                            // AcceptCouponEffectProps acceptCouponEffectProps = (AcceptCouponEffectProps) Newtonsoft.Json.JsonConvert.DeserializeObject(effect.Props.ToString(), typeof(AcceptCouponEffectProps));

                            // Work with AcceptCouponEffectProps' properties
                            // ...
                            // break;
                        default:
                            Debug.WriteLine("Encounter unknown effect type: {0}", effect.EffectType);
                            break;
                    }
                }
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling IntegrationApi.UpdateCustomerSessionV2: " + e.Message );
            }
        }
    }
}

Management API

The following code shows an example of using the Management API:

using System.Collections.Generic;
using System.Diagnostics;
using TalonOne.Api;
using TalonOne.Client;
using TalonOne.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {
            // Configure BasePath & API key authorization: management_key
            var managementConfig = new Configuration {
                BasePath = "https://yourbaseurl.talon.one", // No trailing slash!
                ApiKey = new Dictionary<string, string> {
                    { "Authorization", "2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07" }
                },
                ApiKeyPrefix = new Dictionary<string, string> {
                    { "Authorization", "ManagementKey-v1" }
                }
            };

            // ****************************************************
            // Management API example to load application with id 7
            // ****************************************************

            // When using the default approach, the next initiation of `ManagementApi`
            // could be using the empty constructor
            var managementApi = new ManagementApi(managementConfig);

            try
            {
                // Calling `GetApplication` function with the desired id (7)
                Application app = managementApi.GetApplication(7);
                Debug.WriteLine(app);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagementApi.GetApplication: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Documentation for API endpoints

All URLs are relative to https://yourbaseurl.talon.one.

Class Method HTTP request Description
IntegrationApi CreateAudienceV2 POST /v2/audiences Create audience
IntegrationApi CreateCouponReservation POST /v1/coupon_reservations/{couponValue} Create coupon reservation
IntegrationApi CreateReferral POST /v1/referrals Create referral code for an advocate
IntegrationApi CreateReferralsForMultipleAdvocates POST /v1/referrals_for_multiple_advocates Create referral codes for multiple advocates
IntegrationApi DeleteAudienceMembershipsV2 DELETE /v2/audiences/{audienceId}/memberships Delete audience memberships
IntegrationApi DeleteAudienceV2 DELETE /v2/audiences/{audienceId} Delete audience
IntegrationApi DeleteCouponReservation DELETE /v1/coupon_reservations/{couponValue} Delete coupon reservations
IntegrationApi DeleteCustomerData DELETE /v1/customer_data/{integrationId} Delete customer's personal data
IntegrationApi GenerateLoyaltyCard POST /v1/loyalty_programs/{loyaltyProgramId}/cards Generate loyalty card
IntegrationApi GetCustomerAchievementHistory GET /v1/customer_profiles/{integrationId}/achievements/{achievementId} List customer's achievement history
IntegrationApi GetCustomerAchievements GET /v1/customer_profiles/{integrationId}/achievements List customer's available achievements
IntegrationApi GetCustomerInventory GET /v1/customer_profiles/{integrationId}/inventory List customer data
IntegrationApi GetCustomerSession GET /v2/customer_sessions/{customerSessionId} Get customer session
IntegrationApi GetLoyaltyBalances GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances Get customer's loyalty balances
IntegrationApi GetLoyaltyCardBalances GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances Get card's point balances
IntegrationApi GetLoyaltyCardPoints GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points List card's unused loyalty points
IntegrationApi GetLoyaltyCardTransactions GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions List card's transactions
IntegrationApi GetLoyaltyProgramProfilePoints GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points List customer's unused loyalty points
IntegrationApi GetLoyaltyProgramProfileTransactions GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions List customer's loyalty transactions
IntegrationApi GetReservedCustomers GET /v1/coupon_reservations/customerprofiles/{couponValue} List customers that have this coupon reserved
IntegrationApi LinkLoyaltyCardToProfile POST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile Link customer profile to card
IntegrationApi ReopenCustomerSession PUT /v2/customer_sessions/{customerSessionId}/reopen Reopen customer session
IntegrationApi ReturnCartItems POST /v2/customer_sessions/{customerSessionId}/returns Return cart items
IntegrationApi SyncCatalog PUT /v1/catalogs/{catalogId}/sync Sync cart item catalog
IntegrationApi TrackEventV2 POST /v2/events Track event
IntegrationApi UpdateAudienceCustomersAttributes PUT /v2/audience_customers/{audienceId}/attributes Update profile attributes for all customers in audience
IntegrationApi UpdateAudienceV2 PUT /v2/audiences/{audienceId} Update audience name
IntegrationApi UpdateCustomerProfileAudiences POST /v2/customer_audiences Update multiple customer profiles' audiences
IntegrationApi UpdateCustomerProfileV2 PUT /v2/customer_profiles/{integrationId} Update customer profile
IntegrationApi UpdateCustomerProfilesV2 PUT /v2/customer_profiles Update multiple customer profiles
IntegrationApi UpdateCustomerSessionV2 PUT /v2/customer_sessions/{customerSessionId} Update customer session
ManagementApi ActivateUserByEmail POST /v1/users/activate Enable user by email address
ManagementApi AddLoyaltyCardPoints PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points Add points to card
ManagementApi AddLoyaltyPoints PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points Add points to customer profile
ManagementApi CopyCampaignToApplications POST /v1/applications/{applicationId}/campaigns/{campaignId}/copy Copy the campaign into the specified Application
ManagementApi CreateAccountCollection POST /v1/collections Create account-level collection
ManagementApi CreateAchievement POST /v1/applications/{applicationId}/campaigns/{campaignId}/achievements Create achievement
ManagementApi CreateAdditionalCost POST /v1/additional_costs Create additional cost
ManagementApi CreateAttribute POST /v1/attributes Create custom attribute
ManagementApi CreateBatchLoyaltyCards POST /v1/loyalty_programs/{loyaltyProgramId}/cards/batch Create loyalty cards
ManagementApi CreateCampaignFromTemplate POST /v1/applications/{applicationId}/create_campaign_from_template Create campaign from campaign template
ManagementApi CreateCollection POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections Create campaign-level collection
ManagementApi CreateCoupons POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Create coupons
ManagementApi CreateCouponsAsync POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async Create coupons asynchronously
ManagementApi CreateCouponsDeletionJob POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs Creates a coupon deletion job
ManagementApi CreateCouponsForMultipleRecipients POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients Create coupons for multiple recipients
ManagementApi CreateInviteEmail POST /v1/invite_emails Resend invitation email
ManagementApi CreateInviteV2 POST /v2/invites Invite user
ManagementApi CreatePasswordRecoveryEmail POST /v1/password_recovery_emails Request a password reset
ManagementApi CreateSession POST /v1/sessions Create session
ManagementApi CreateStore POST /v1/applications/{applicationId}/stores Create store
ManagementApi DeactivateUserByEmail POST /v1/users/deactivate Disable user by email address
ManagementApi DeductLoyaltyCardPoints PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points Deduct points from card
ManagementApi DeleteAccountCollection DELETE /v1/collections/{collectionId} Delete account-level collection
ManagementApi DeleteAchievement DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Delete achievement
ManagementApi DeleteCampaign DELETE /v1/applications/{applicationId}/campaigns/{campaignId} Delete campaign
ManagementApi DeleteCollection DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} Delete campaign-level collection
ManagementApi DeleteCoupon DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} Delete coupon
ManagementApi DeleteCoupons DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Delete coupons
ManagementApi DeleteLoyaltyCard DELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} Delete loyalty card
ManagementApi DeleteReferral DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} Delete referral
ManagementApi DeleteStore DELETE /v1/applications/{applicationId}/stores/{storeId} Delete store
ManagementApi DeleteUser DELETE /v1/users/{userId} Delete user
ManagementApi DeleteUserByEmail POST /v1/users/delete Delete user by email address
ManagementApi DestroySession DELETE /v1/sessions Destroy session
ManagementApi DisconnectCampaignStores DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores Disconnect stores
ManagementApi ExportAccountCollectionItems GET /v1/collections/{collectionId}/export Export account-level collection's items
ManagementApi ExportAchievements GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export Export achievement customer data
ManagementApi ExportAudiencesMemberships GET /v1/audiences/{audienceId}/memberships/export Export audience members
ManagementApi ExportCampaignStores GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export Export stores
ManagementApi ExportCollectionItems GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export Export campaign-level collection's items
ManagementApi ExportCoupons GET /v1/applications/{applicationId}/export_coupons Export coupons
ManagementApi ExportCustomerSessions GET /v1/applications/{applicationId}/export_customer_sessions Export customer sessions
ManagementApi ExportCustomersTiers GET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers Export customers' tier data
ManagementApi ExportEffects GET /v1/applications/{applicationId}/export_effects Export triggered effects
ManagementApi ExportLoyaltyBalance GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance Export customer loyalty balance to CSV
ManagementApi ExportLoyaltyBalances GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances Export customer loyalty balances
ManagementApi ExportLoyaltyCardBalances GET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances Export all card transaction logs
ManagementApi ExportLoyaltyCardLedger GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log Export card's ledger log
ManagementApi ExportLoyaltyCards GET /v1/loyalty_programs/{loyaltyProgramId}/cards/export Export loyalty cards
ManagementApi ExportLoyaltyLedger GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log Export customer's transaction logs
ManagementApi ExportPoolGiveaways GET /v1/giveaways/pools/{poolId}/export Export giveaway codes of a giveaway pool
ManagementApi ExportReferrals GET /v1/applications/{applicationId}/export_referrals Export referrals
ManagementApi GetAccessLogsWithoutTotalCount GET /v1/applications/{applicationId}/access_logs/no_total Get access logs for Application
ManagementApi GetAccount GET /v1/accounts/{accountId} Get account details
ManagementApi GetAccountAnalytics GET /v1/accounts/{accountId}/analytics Get account analytics
ManagementApi GetAccountCollection GET /v1/collections/{collectionId} Get account-level collection
ManagementApi GetAchievement GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Get achievement
ManagementApi GetAdditionalCost GET /v1/additional_costs/{additionalCostId} Get additional cost
ManagementApi GetAdditionalCosts GET /v1/additional_costs List additional costs
ManagementApi GetApplication GET /v1/applications/{applicationId} Get Application
ManagementApi GetApplicationApiHealth GET /v1/applications/{applicationId}/health_report Get Application health
ManagementApi GetApplicationCustomer GET /v1/applications/{applicationId}/customers/{customerId} Get application's customer
ManagementApi GetApplicationCustomerFriends GET /v1/applications/{applicationId}/profile/{integrationId}/friends List friends referred by customer profile
ManagementApi GetApplicationCustomers GET /v1/applications/{applicationId}/customers List application's customers
ManagementApi GetApplicationCustomersByAttributes POST /v1/applications/{applicationId}/customer_search List application customers matching the given attributes
ManagementApi GetApplicationEventTypes GET /v1/applications/{applicationId}/event_types List Applications event types
ManagementApi GetApplicationEventsWithoutTotalCount GET /v1/applications/{applicationId}/events/no_total List Applications events
ManagementApi GetApplicationSession GET /v1/applications/{applicationId}/sessions/{sessionId} Get Application session
ManagementApi GetApplicationSessions GET /v1/applications/{applicationId}/sessions List Application sessions
ManagementApi GetApplications GET /v1/applications List Applications
ManagementApi GetAttribute GET /v1/attributes/{attributeId} Get custom attribute
ManagementApi GetAttributes GET /v1/attributes List custom attributes
ManagementApi GetAudienceMemberships GET /v1/audiences/{audienceId}/memberships List audience members
ManagementApi GetAudiences GET /v1/audiences List audiences
ManagementApi GetAudiencesAnalytics GET /v1/audiences/analytics List audience analytics
ManagementApi GetCampaign GET /v1/applications/{applicationId}/campaigns/{campaignId} Get campaign
ManagementApi GetCampaignAnalytics GET /v1/applications/{applicationId}/campaigns/{campaignId}/analytics Get analytics of campaigns
ManagementApi GetCampaignByAttributes POST /v1/applications/{applicationId}/campaigns_search List campaigns that match the given attributes
ManagementApi GetCampaignGroup GET /v1/campaign_groups/{campaignGroupId} Get campaign access group
ManagementApi GetCampaignGroups GET /v1/campaign_groups List campaign access groups
ManagementApi GetCampaignTemplates GET /v1/campaign_templates List campaign templates
ManagementApi GetCampaigns GET /v1/applications/{applicationId}/campaigns List campaigns
ManagementApi GetChanges GET /v1/changes Get audit logs for an account
ManagementApi GetCollection GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} Get campaign-level collection
ManagementApi GetCollectionItems GET /v1/collections/{collectionId}/items Get collection items
ManagementApi GetCouponsWithoutTotalCount GET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total List coupons
ManagementApi GetCustomerActivityReport GET /v1/applications/{applicationId}/customer_activity_reports/{customerId} Get customer's activity report
ManagementApi GetCustomerActivityReportsWithoutTotalCount GET /v1/applications/{applicationId}/customer_activity_reports/no_total Get Activity Reports for Application Customers
ManagementApi GetCustomerAnalytics GET /v1/applications/{applicationId}/customers/{customerId}/analytics Get customer's analytics report
ManagementApi GetCustomerProfile GET /v1/customers/{customerId} Get customer profile
ManagementApi GetCustomerProfileAchievementProgress GET /v1/applications/{applicationId}/achievement_progress/{integrationId} List customer achievements
ManagementApi GetCustomerProfiles GET /v1/customers/no_total List customer profiles
ManagementApi GetCustomersByAttributes POST /v1/customer_search/no_total List customer profiles matching the given attributes
ManagementApi GetDashboardStatistics GET /v1/loyalty_programs/{loyaltyProgramId}/dashboard Get statistics for loyalty dashboard
ManagementApi GetEventTypes GET /v1/event_types List event types
ManagementApi GetExports GET /v1/exports Get exports
ManagementApi GetLoyaltyCard GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} Get loyalty card
ManagementApi GetLoyaltyCardTransactionLogs GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs List card's transactions
ManagementApi GetLoyaltyCards GET /v1/loyalty_programs/{loyaltyProgramId}/cards List loyalty cards
ManagementApi GetLoyaltyPoints GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} Get customer's full loyalty ledger
ManagementApi GetLoyaltyProgram GET /v1/loyalty_programs/{loyaltyProgramId} Get loyalty program
ManagementApi GetLoyaltyProgramTransactions GET /v1/loyalty_programs/{loyaltyProgramId}/transactions List loyalty program transactions
ManagementApi GetLoyaltyPrograms GET /v1/loyalty_programs List loyalty programs
ManagementApi GetLoyaltyStatistics GET /v1/loyalty_programs/{loyaltyProgramId}/statistics Get loyalty program statistics
ManagementApi GetMessageLogs GET /v1/message_logs List message log entries
ManagementApi GetReferralsWithoutTotalCount GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total List referrals
ManagementApi GetRoleV2 GET /v2/roles/{roleId} Get role
ManagementApi GetRuleset GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} Get ruleset
ManagementApi GetRulesets GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets List campaign rulesets
ManagementApi GetStore GET /v1/applications/{applicationId}/stores/{storeId} Get store
ManagementApi GetUser GET /v1/users/{userId} Get user
ManagementApi GetUsers GET /v1/users List users in account
ManagementApi GetWebhook GET /v1/webhooks/{webhookId} Get webhook
ManagementApi GetWebhookActivationLogs GET /v1/webhook_activation_logs List webhook activation log entries
ManagementApi GetWebhookLogs GET /v1/webhook_logs List webhook log entries
ManagementApi GetWebhooks GET /v1/webhooks List webhooks
ManagementApi ImportAccountCollection POST /v1/collections/{collectionId}/import Import data into existing account-level collection
ManagementApi ImportAllowedList POST /v1/attributes/{attributeId}/allowed_list/import Import allowed values for attribute
ManagementApi ImportAudiencesMemberships POST /v1/audiences/{audienceId}/memberships/import Import audience members
ManagementApi ImportCampaignStores POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import Import stores
ManagementApi ImportCollection POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import Import data into existing campaign-level collection
ManagementApi ImportCoupons POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons Import coupons
ManagementApi ImportLoyaltyCards POST /v1/loyalty_programs/{loyaltyProgramId}/import_cards Import loyalty cards
ManagementApi ImportLoyaltyCustomersTiers POST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers Import customers into loyalty tiers
ManagementApi ImportLoyaltyPoints POST /v1/loyalty_programs/{loyaltyProgramId}/import_points Import loyalty points
ManagementApi ImportPoolGiveaways POST /v1/giveaways/pools/{poolId}/import Import giveaway codes into a giveaway pool
ManagementApi ImportReferrals POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals Import referrals
ManagementApi InviteUserExternal POST /v1/users/invite Invite user from identity provider
ManagementApi ListAccountCollections GET /v1/collections List collections in account
ManagementApi ListAchievements GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements List achievements
ManagementApi ListAllRolesV2 GET /v2/roles List roles
ManagementApi ListCatalogItems GET /v1/catalogs/{catalogId}/items List items in a catalog
ManagementApi ListCollections GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections List collections in campaign
ManagementApi ListCollectionsInApplication GET /v1/applications/{applicationId}/collections List collections in Application
ManagementApi ListStores GET /v1/applications/{applicationId}/stores List stores
ManagementApi OktaEventHandlerChallenge GET /v1/provisioning/okta Validate Okta API ownership
ManagementApi RemoveLoyaltyPoints PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points Deduct points from customer profile
ManagementApi ResetPassword POST /v1/reset_password Reset password
ManagementApi ScimCreateUser POST /v1/provisioning/scim/Users Create SCIM user
ManagementApi ScimDeleteUser DELETE /v1/provisioning/scim/Users/{userId} Delete SCIM user
ManagementApi ScimGetResourceTypes GET /v1/provisioning/scim/ResourceTypes List supported SCIM resource types
ManagementApi ScimGetSchemas GET /v1/provisioning/scim/Schemas List supported SCIM schemas
ManagementApi ScimGetServiceProviderConfig GET /v1/provisioning/scim/ServiceProviderConfig Get SCIM service provider configuration
ManagementApi ScimGetUser GET /v1/provisioning/scim/Users/{userId} Get SCIM user
ManagementApi ScimGetUsers GET /v1/provisioning/scim/Users List SCIM users
ManagementApi ScimPatchUser PATCH /v1/provisioning/scim/Users/{userId} Update SCIM user attributes
ManagementApi ScimReplaceUserAttributes PUT /v1/provisioning/scim/Users/{userId} Update SCIM user
ManagementApi SearchCouponsAdvancedApplicationWideWithoutTotalCount POST /v1/applications/{applicationId}/coupons_search_advanced/no_total List coupons that match the given attributes (without total count)
ManagementApi SearchCouponsAdvancedWithoutTotalCount POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total List coupons that match the given attributes in campaign (without total count)
ManagementApi TransferLoyaltyCard PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer Transfer card data
ManagementApi UpdateAccountCollection PUT /v1/collections/{collectionId} Update account-level collection
ManagementApi UpdateAchievement PUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Update achievement
ManagementApi UpdateAdditionalCost PUT /v1/additional_costs/{additionalCostId} Update additional cost
ManagementApi UpdateAttribute PUT /v1/attributes/{attributeId} Update custom attribute
ManagementApi UpdateCampaign PUT /v1/applications/{applicationId}/campaigns/{campaignId} Update campaign
ManagementApi UpdateCollection PUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} Update campaign-level collection's description
ManagementApi UpdateCoupon PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} Update coupon
ManagementApi UpdateCouponBatch PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons Update coupons
ManagementApi UpdateLoyaltyCard PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} Update loyalty card status
ManagementApi UpdateReferral PUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} Update referral
ManagementApi UpdateRoleV2 PUT /v2/roles/{roleId} Update role
ManagementApi UpdateStore PUT /v1/applications/{applicationId}/stores/{storeId} Update store
ManagementApi UpdateUser PUT /v1/users/{userId} Update user

Documentation for models

Authorization

api_key_v1

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

management_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

manager_auth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
10.0.0 566 5/5/2025
9.0.0 4,171 4/14/2025
8.0.0 3,616 1/16/2025
7.0.1 1,420 10/24/2024
6.0.0 6,593 6/5/2024
5.0.2 36,626 11/14/2023
5.0.1 4,522 9/1/2023
5.0.0 15,161 5/9/2023
4.0.4 20,884 3/27/2022
4.0.3 2,002 3/14/2022
4.0.2 42,038 11/8/2021
4.0.1 2,390 8/13/2021
4.0.0 1,723 6/25/2021
3.5.0 3,000 6/2/2021
3.4.0 459 4/13/2021
3.3.0 1,659 10/10/2020
3.2.0 807 7/31/2020
3.1.0 646 6/5/2020
3.0.0 645 4/20/2020
2.3.0 1,355 12/23/2019
2.2.0 860 11/14/2019
2.1.0 645 10/1/2019
2.0.1 693 9/11/2019
2.0.0 675 9/5/2019
1.0.0 1,250 7/31/2017