Use the Talon.One API to integrate with your application and to manage applications and campaigns:
- Use the operations in the Integration API section are used to integrate with our platform
- Use the operation in the Management API section to manage applications and campaigns.
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 updateCustomerSessionV2 endpoint
is https://yourbaseurl.talon.one/v2/customer_sessions/{Id}
This Python package is automatically generated by the OpenAPI Generator project:
- API version:
- Package version: 6.1.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/talon-one/talon_one.py.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/talon-one/talon_one.py.git
)
Then import the package:
import talon_one
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import talon_one
Please follow the installation procedure and then run the following:
import talon_one
from talon_one.rest import ApiException
from pprint import pprint
import json
# Create configuration with your host destination and authorization using api_key_v1
configuration = talon_one.Configuration(
host = "https://yourbaseurl.talon.one",
api_key_prefix = {
"Authorization": "ApiKey-v1"
},
api_key = {
"Authorization": "e18149e88f42247f0123456789abcdef9302722577ad60cebc86c4333b6fb70"
}
)
# Integration API example to send a session update
integration_api = talon_one.IntegrationApi(talon_one.ApiClient(configuration))
# Preparing a NewCustomerSessionV2 object
customer_session = talon_one.NewCustomerSessionV2(
"PROFILE_ID"
)
customer_session.cart_items = [
talon_one.CartItem(name="Red Spring Blouse",
sku="rdbs-1111",
quantity=1,
price=49,
category="Shirts"),
talon_one.CartItem(name="Denim Trousers",
sku="dtr-2222",
quantity=1,
price=74,
category="Trousers"),
]
customer_session.coupon_codes = [
"Cool_Stuff"
]
# Instantiating a new IntegrationRequest object
integration_request = talon_one.IntegrationRequest(
customer_session,
# Optional list of requested information to be present on the response.
# See models/integration_request.py for full list
# ["customerSession", "loyalty"]
)
try:
# Create/update a customer session using `update_customer_session_v2` function
api_response = integration_api.update_customer_session_v2("my_unique_session_v2_id", integration_request)
encoded_data = json.dumps(api_response.to_dict(), default=str)
pprint(encoded_data)
# 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
for effect in api_response.effects:
if effect.effect_type == "setDiscount":
# Initiating right props instance according to the effect type
setDiscountProps = integration_api.api_client.deserialize_model(effect.props, talon_one.SetDiscountEffectProps)
# Access the specific effect's properties
print("Set a discount '{name}' of {value}".format(
name = setDiscountProps.name,
value = setDiscountProps.value
))
elif effect.effect_type == "rejectCoupon":
rejectCouponEffectProps = integration_api.api_client.deserialize_model(effect.props, talon_one.RejectCouponEffectProps)
# Work with AcceptCouponEffectProps' properties
# ...
except ApiException as e:
print("Exception when calling IntegrationApi->update_customer_session_v2: %s\n" % e)
import talon_one
from pprint import pprint
import json
# Create configuration with your host destination and authorization using management_key
configuration = talon_one.Configuration(
host = "https://yourbaseurl.talon.one",
api_key_prefix = {
"Authorization": "ManagementKey-v1"
},
api_key = {
"Authorization": "2f0dce055da01ae595005d7d79154bae7448d319d5fc7c5b2951fadd6ba1ea07"
}
)
# Management API example to load application with id 7
management_api = talon_one.ManagementApi(talon_one.ApiClient(configuration))
try:
# Calling get_application function with the desired id (7)
application = management_api.get_application(7)
encoded_data = json.dumps(application.to_dict(), default=str)
pprint(encoded_data)
except ApiException as e:
print("Exception when calling ManagementApi: %s\n" % e)
All URIs are relative to https://yourbaseurl.talon.one
Class | Method | HTTP request | Description |
---|---|---|---|
IntegrationApi | create_audience_v2 | POST /v2/audiences | Create audience |
IntegrationApi | create_coupon_reservation | POST /v1/coupon_reservations/{couponValue} | Create coupon reservation |
IntegrationApi | create_referral | POST /v1/referrals | Create referral code for an advocate |
IntegrationApi | create_referrals_for_multiple_advocates | POST /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates |
IntegrationApi | delete_audience_memberships_v2 | DELETE /v2/audiences/{audienceId}/memberships | Delete audience memberships |
IntegrationApi | delete_audience_v2 | DELETE /v2/audiences/{audienceId} | Delete audience |
IntegrationApi | delete_coupon_reservation | DELETE /v1/coupon_reservations/{couponValue} | Delete coupon reservations |
IntegrationApi | delete_customer_data | DELETE /v1/customer_data/{integrationId} | Delete customer's personal data |
IntegrationApi | generate_loyalty_card | POST /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card |
IntegrationApi | get_customer_inventory | GET /v1/customer_profiles/{integrationId}/inventory | List customer data |
IntegrationApi | get_customer_session | GET /v2/customer_sessions/{customerSessionId} | Get customer session |
IntegrationApi | get_loyalty_balances | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points |
IntegrationApi | get_loyalty_card_balances | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances |
IntegrationApi | get_loyalty_card_points | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points |
IntegrationApi | get_loyalty_card_transactions | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions |
IntegrationApi | get_loyalty_program_profile_points | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points | List customer's unused loyalty points |
IntegrationApi | get_loyalty_program_profile_transactions | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions |
IntegrationApi | get_reserved_customers | GET /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved |
IntegrationApi | link_loyalty_card_to_profile | POST /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile | Link customer profile to card |
IntegrationApi | reopen_customer_session | PUT /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session |
IntegrationApi | return_cart_items | POST /v2/customer_sessions/{customerSessionId}/returns | Return cart items |
IntegrationApi | sync_catalog | PUT /v1/catalogs/{catalogId}/sync | Sync cart item catalog |
IntegrationApi | track_event_v2 | POST /v2/events | Track event |
IntegrationApi | update_audience_customers_attributes | PUT /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience |
IntegrationApi | update_audience_v2 | PUT /v2/audiences/{audienceId} | Update audience name |
IntegrationApi | update_customer_profile_audiences | POST /v2/customer_audiences | Update multiple customer profiles' audiences |
IntegrationApi | update_customer_profile_v2 | PUT /v2/customer_profiles/{integrationId} | Update customer profile |
IntegrationApi | update_customer_profiles_v2 | PUT /v2/customer_profiles | Update multiple customer profiles |
IntegrationApi | update_customer_session_v2 | PUT /v2/customer_sessions/{customerSessionId} | Update customer session |
ManagementApi | activate_user_by_email | POST /v1/users/activate | Enable user by email address |
ManagementApi | add_loyalty_card_points | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card |
ManagementApi | add_loyalty_points | PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile |
ManagementApi | copy_campaign_to_applications | POST /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application |
ManagementApi | create_account_collection | POST /v1/collections | Create account-level collection |
ManagementApi | create_achievement | POST /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement |
ManagementApi | create_additional_cost | POST /v1/additional_costs | Create additional cost |
ManagementApi | create_attribute | POST /v1/attributes | Create custom attribute |
ManagementApi | create_campaign_from_template | POST /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template |
ManagementApi | create_collection | POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection |
ManagementApi | create_coupons | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons |
ManagementApi | create_coupons_async | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously |
ManagementApi | create_coupons_deletion_job | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job |
ManagementApi | create_coupons_for_multiple_recipients | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients |
ManagementApi | create_invite_email | POST /v1/invite_emails | Resend invitation email |
ManagementApi | create_invite_v2 | POST /v2/invites | Invite user |
ManagementApi | create_password_recovery_email | POST /v1/password_recovery_emails | Request a password reset |
ManagementApi | create_session | POST /v1/sessions | Create session |
ManagementApi | create_store | POST /v1/applications/{applicationId}/stores | Create store |
ManagementApi | deactivate_user_by_email | POST /v1/users/deactivate | Disable user by email address |
ManagementApi | deduct_loyalty_card_points | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card |
ManagementApi | delete_account_collection | DELETE /v1/collections/{collectionId} | Delete account-level collection |
ManagementApi | delete_achievement | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement |
ManagementApi | delete_campaign | DELETE /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign |
ManagementApi | delete_collection | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection |
ManagementApi | delete_coupon | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon |
ManagementApi | delete_coupons | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons |
ManagementApi | delete_loyalty_card | DELETE /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Delete loyalty card |
ManagementApi | delete_referral | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete referral |
ManagementApi | delete_store | DELETE /v1/applications/{applicationId}/stores/{storeId} | Delete store |
ManagementApi | delete_user | DELETE /v1/users/{userId} | Delete user |
ManagementApi | delete_user_by_email | POST /v1/users/delete | Delete user by email address |
ManagementApi | destroy_session | DELETE /v1/sessions | Destroy session |
ManagementApi | disconnect_campaign_stores | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores |
ManagementApi | export_account_collection_items | GET /v1/collections/{collectionId}/export | Export account-level collection's items |
ManagementApi | export_achievements | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data |
ManagementApi | export_audiences_memberships | GET /v1/audiences/{audienceId}/memberships/export | Export audience members |
ManagementApi | export_campaign_stores | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores |
ManagementApi | export_collection_items | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items |
ManagementApi | export_coupons | GET /v1/applications/{applicationId}/export_coupons | Export coupons |
ManagementApi | export_customer_sessions | GET /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions |
ManagementApi | export_customers_tiers | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customers_tiers | Export customers' tier data |
ManagementApi | export_effects | GET /v1/applications/{applicationId}/export_effects | Export triggered effects |
ManagementApi | export_loyalty_balance | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balance | Export customer loyalty balance to CSV |
ManagementApi | export_loyalty_balances | GET /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances |
ManagementApi | export_loyalty_card_balances | GET /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs |
ManagementApi | export_loyalty_card_ledger | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log |
ManagementApi | export_loyalty_ledger | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs |
ManagementApi | export_pool_giveaways | GET /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool |
ManagementApi | export_referrals | GET /v1/applications/{applicationId}/export_referrals | Export referrals |
ManagementApi | get_access_logs_without_total_count | GET /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application |
ManagementApi | get_account | GET /v1/accounts/{accountId} | Get account details |
ManagementApi | get_account_analytics | GET /v1/accounts/{accountId}/analytics | Get account analytics |
ManagementApi | get_account_collection | GET /v1/collections/{collectionId} | Get account-level collection |
ManagementApi | get_achievement | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement |
ManagementApi | get_additional_cost | GET /v1/additional_costs/{additionalCostId} | Get additional cost |
ManagementApi | get_additional_costs | GET /v1/additional_costs | List additional costs |
ManagementApi | get_all_access_logs | GET /v1/access_logs | List access logs |
ManagementApi | get_application | GET /v1/applications/{applicationId} | Get Application |
ManagementApi | get_application_api_health | GET /v1/applications/{applicationId}/health_report | Get Application health |
ManagementApi | get_application_customer | GET /v1/applications/{applicationId}/customers/{customerId} | Get application's customer |
ManagementApi | get_application_customer_friends | GET /v1/applications/{applicationId}/profile/{integrationId}/friends | List friends referred by customer profile |
ManagementApi | get_application_customers | GET /v1/applications/{applicationId}/customers | List application's customers |
ManagementApi | get_application_customers_by_attributes | POST /v1/applications/{applicationId}/customer_search | List application customers matching the given attributes |
ManagementApi | get_application_event_types | GET /v1/applications/{applicationId}/event_types | List Applications event types |
ManagementApi | get_application_events_without_total_count | GET /v1/applications/{applicationId}/events/no_total | List Applications events |
ManagementApi | get_application_session | GET /v1/applications/{applicationId}/sessions/{sessionId} | Get Application session |
ManagementApi | get_application_sessions | GET /v1/applications/{applicationId}/sessions | List Application sessions |
ManagementApi | get_applications | GET /v1/applications | List Applications |
ManagementApi | get_attribute | GET /v1/attributes/{attributeId} | Get custom attribute |
ManagementApi | get_attributes | GET /v1/attributes | List custom attributes |
ManagementApi | get_audience_memberships | GET /v1/audiences/{audienceId}/memberships | List audience members |
ManagementApi | get_audiences | GET /v1/audiences | List audiences |
ManagementApi | get_audiences_analytics | GET /v1/audiences/analytics | List audience analytics |
ManagementApi | get_campaign | GET /v1/applications/{applicationId}/campaigns/{campaignId} | Get campaign |
ManagementApi | get_campaign_analytics | GET /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns |
ManagementApi | get_campaign_by_attributes | POST /v1/applications/{applicationId}/campaigns_search | List campaigns that match the given attributes |
ManagementApi | get_campaign_group | GET /v1/campaign_groups/{campaignGroupId} | Get campaign access group |
ManagementApi | get_campaign_groups | GET /v1/campaign_groups | List campaign access groups |
ManagementApi | get_campaign_templates | GET /v1/campaign_templates | List campaign templates |
ManagementApi | get_campaigns | GET /v1/applications/{applicationId}/campaigns | List campaigns |
ManagementApi | get_changes | GET /v1/changes | Get audit logs for an account |
ManagementApi | get_collection | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection |
ManagementApi | get_collection_items | GET /v1/collections/{collectionId}/items | Get collection items |
ManagementApi | get_coupons_without_total_count | GET /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons |
ManagementApi | get_customer_activity_report | GET /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report |
ManagementApi | get_customer_activity_reports_without_total_count | GET /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers |
ManagementApi | get_customer_analytics | GET /v1/applications/{applicationId}/customers/{customerId}/analytics | Get customer's analytics report |
ManagementApi | get_customer_profile | GET /v1/customers/{customerId} | Get customer profile |
ManagementApi | get_customer_profile_achievement_progress | GET /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements |
ManagementApi | get_customer_profiles | GET /v1/customers/no_total | List customer profiles |
ManagementApi | get_customers_by_attributes | POST /v1/customer_search/no_total | List customer profiles matching the given attributes |
ManagementApi | get_event_types | GET /v1/event_types | List event types |
ManagementApi | get_exports | GET /v1/exports | Get exports |
ManagementApi | get_loyalty_card | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card |
ManagementApi | get_loyalty_card_transaction_logs | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions |
ManagementApi | get_loyalty_cards | GET /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards |
ManagementApi | get_loyalty_points | GET /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger |
ManagementApi | get_loyalty_program | GET /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program |
ManagementApi | get_loyalty_program_transactions | GET /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions |
ManagementApi | get_loyalty_programs | GET /v1/loyalty_programs | List loyalty programs |
ManagementApi | get_loyalty_statistics | GET /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics |
ManagementApi | get_referrals_without_total_count | GET /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals |
ManagementApi | get_role_v2 | GET /v2/roles/{roleId} | Get role |
ManagementApi | get_ruleset | GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset |
ManagementApi | get_rulesets | GET /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets |
ManagementApi | get_store | GET /v1/applications/{applicationId}/stores/{storeId} | Get store |
ManagementApi | get_user | GET /v1/users/{userId} | Get user |
ManagementApi | get_users | GET /v1/users | List users in account |
ManagementApi | get_webhook | GET /v1/webhooks/{webhookId} | Get webhook |
ManagementApi | get_webhook_activation_logs | GET /v1/webhook_activation_logs | List webhook activation log entries |
ManagementApi | get_webhook_logs | GET /v1/webhook_logs | List webhook log entries |
ManagementApi | get_webhooks | GET /v1/webhooks | List webhooks |
ManagementApi | import_account_collection | POST /v1/collections/{collectionId}/import | Import data into existing account-level collection |
ManagementApi | import_allowed_list | POST /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute |
ManagementApi | import_audiences_memberships | POST /v1/audiences/{audienceId}/memberships/import | Import audience members |
ManagementApi | import_campaign_stores | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores |
ManagementApi | import_collection | POST /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection |
ManagementApi | import_coupons | POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons |
ManagementApi | import_loyalty_cards | POST /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards |
ManagementApi | import_loyalty_customers_tiers | POST /v1/loyalty_programs/{loyaltyProgramId}/import_customers_tiers | Import customers into loyalty tiers |
ManagementApi | import_loyalty_points | POST /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points |
ManagementApi | import_pool_giveaways | POST /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool |
ManagementApi | import_referrals | POST /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals |
ManagementApi | invite_user_external | POST /v1/users/invite | Invite user from identity provider |
ManagementApi | list_account_collections | GET /v1/collections | List collections in account |
ManagementApi | list_achievements | GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements |
ManagementApi | list_all_roles_v2 | GET /v2/roles | List roles |
ManagementApi | list_catalog_items | GET /v1/catalogs/{catalogId}/items | List items in a catalog |
ManagementApi | list_collections | GET /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign |
ManagementApi | list_collections_in_application | GET /v1/applications/{applicationId}/collections | List collections in Application |
ManagementApi | list_stores | GET /v1/applications/{applicationId}/stores | List stores |
ManagementApi | notification_activation | PUT /v1/notifications/{notificationId}/activation | Activate or deactivate notification |
ManagementApi | okta_event_handler_challenge | GET /v1/provisioning/okta | Validate Okta API ownership |
ManagementApi | post_added_deducted_points_notification | POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points |
ManagementApi | post_catalogs_strikethrough_notification | POST /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification |
ManagementApi | post_pending_points_notification | POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points |
ManagementApi | remove_loyalty_points | PUT /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile |
ManagementApi | reset_password | POST /v1/reset_password | Reset password |
ManagementApi | scim_create_user | POST /v1/provisioning/scim/Users | Create SCIM user |
ManagementApi | scim_delete_user | DELETE /v1/provisioning/scim/Users/{userId} | Delete SCIM user |
ManagementApi | scim_get_resource_types | GET /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types |
ManagementApi | scim_get_schemas | GET /v1/provisioning/scim/Schemas | List supported SCIM schemas |
ManagementApi | scim_get_service_provider_config | GET /v1/provisioning/scim/ServiceProviderConfig | Service config endpoint for SCIM provisioning protocol |
ManagementApi | scim_get_user | GET /v1/provisioning/scim/Users/{userId} | Get SCIM user |
ManagementApi | scim_get_users | GET /v1/provisioning/scim/Users | List SCIM users |
ManagementApi | scim_patch_user | PATCH /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes |
ManagementApi | scim_replace_user_attributes | PUT /v1/provisioning/scim/Users/{userId} | Update SCIM user |
ManagementApi | search_coupons_advanced_application_wide_without_total_count | POST /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) |
ManagementApi | search_coupons_advanced_without_total_count | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) |
ManagementApi | transfer_loyalty_card | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data |
ManagementApi | update_account_collection | PUT /v1/collections/{collectionId} | Update account-level collection |
ManagementApi | update_achievement | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement |
ManagementApi | update_additional_cost | PUT /v1/additional_costs/{additionalCostId} | Update additional cost |
ManagementApi | update_attribute | PUT /v1/attributes/{attributeId} | Update custom attribute |
ManagementApi | update_campaign | PUT /v1/applications/{applicationId}/campaigns/{campaignId} | Update campaign |
ManagementApi | update_collection | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update campaign-level collection's description |
ManagementApi | update_coupon | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon |
ManagementApi | update_coupon_batch | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons |
ManagementApi | update_loyalty_card | PUT /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status |
ManagementApi | update_referral | PUT /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral |
ManagementApi | update_role_v2 | PUT /v2/roles/{roleId} | Update role |
ManagementApi | update_store | PUT /v1/applications/{applicationId}/stores/{storeId} | Update store |
ManagementApi | update_user | PUT /v1/users/{userId} | Update user |
- APIError
- AcceptCouponEffectProps
- AcceptReferralEffectProps
- AccessLogEntry
- Account
- AccountAdditionalCost
- AccountAnalytics
- AccountDashboardStatistic
- AccountDashboardStatisticCampaigns
- AccountDashboardStatisticDiscount
- AccountDashboardStatisticLoyaltyPoints
- AccountDashboardStatisticReferrals
- AccountDashboardStatisticRevenue
- AccountEntity
- AccountLimits
- Achievement
- AchievementAdditionalProperties
- AchievementProgress
- ActivateUserRequest
- AddFreeItemEffectProps
- AddItemCatalogAction
- AddLoyaltyPoints
- AddLoyaltyPointsEffectProps
- AddToAudienceEffectProps
- AddedDeductedPointsNotificationPolicy
- AdditionalCampaignProperties
- AdditionalCost
- AnalyticsDataPoint
- AnalyticsDataPointWithTrend
- AnalyticsDataPointWithTrendAndInfluencedRate
- AnalyticsDataPointWithTrendAndUplift
- Application
- ApplicationAPIKey
- ApplicationAnalyticsDataPoint
- ApplicationApiHealth
- ApplicationCampaignAnalytics
- ApplicationCampaignStats
- ApplicationCustomer
- ApplicationCustomerEntity
- ApplicationEntity
- ApplicationEvent
- ApplicationNotification
- ApplicationReferee
- ApplicationSession
- ApplicationSessionEntity
- ApplicationStoreEntity
- AsyncCouponCreationResponse
- AsyncCouponDeletionJobResponse
- Attribute
- AttributesMandatory
- AttributesSettings
- Audience
- AudienceAnalytics
- AudienceCustomer
- AudienceIntegrationID
- AudienceMembership
- AwardGiveawayEffectProps
- BaseCampaign
- BaseLoyaltyProgram
- BaseNotification
- BaseNotificationEntity
- BaseNotificationWebhook
- BaseNotifications
- BaseSamlConnection
- Binding
- BulkApplicationNotification
- BulkCampaignNotification
- BulkOperationOnCampaigns
- Campaign
- CampaignActivationRequest
- CampaignAnalytics
- CampaignBudget
- CampaignCollection
- CampaignCollectionEditedNotification
- CampaignCollectionWithoutPayload
- CampaignCopy
- CampaignCreatedNotification
- CampaignDeletedNotification
- CampaignEditedNotification
- CampaignEntity
- CampaignEvaluationGroup
- CampaignEvaluationPosition
- CampaignEvaluationTreeChangedNotification
- CampaignGroup
- CampaignGroupEntity
- CampaignNotification
- CampaignNotificationPolicy
- CampaignRulesetChangedNotification
- CampaignSearch
- CampaignSet
- CampaignSetBranchNode
- CampaignSetLeafNode
- CampaignSetNode
- CampaignStateChangedNotification
- CampaignTemplate
- CampaignTemplateCollection
- CampaignTemplateParams
- CardAddedDeductedPointsNotificationPolicy
- CardExpiringPointsNotificationPolicy
- CardExpiringPointsNotificationTrigger
- CardLedgerPointsEntryIntegrationAPI
- CardLedgerTransactionLogEntry
- CardLedgerTransactionLogEntryIntegrationAPI
- CartItem
- Catalog
- CatalogAction
- CatalogActionFilter
- CatalogItem
- CatalogSyncRequest
- CatalogsStrikethroughNotificationPolicy
- Change
- ChangeLoyaltyTierLevelEffectProps
- ChangeProfilePassword
- CodeGeneratorSettings
- Collection
- CollectionItem
- CollectionWithoutPayload
- Coupon
- CouponConstraints
- CouponCreatedEffectProps
- CouponCreationJob
- CouponDeletionFilters
- CouponDeletionJob
- CouponLimitConfigs
- CouponRejectionReason
- CouponReservations
- CouponSearch
- CouponValue
- CouponsNotificationPolicy
- CreateAchievement
- CreateApplicationAPIKey
- CreateManagementKey
- CreateTemplateCampaign
- CreateTemplateCampaignResponse
- CustomEffect
- CustomEffectProps
- CustomerActivityReport
- CustomerAnalytics
- CustomerInventory
- CustomerProfile
- CustomerProfileAudienceRequest
- CustomerProfileAudienceRequestItem
- CustomerProfileIntegrationRequestV2
- CustomerProfileIntegrationResponseV2
- CustomerProfileSearchQuery
- CustomerProfileUpdateV2Response
- CustomerSession
- CustomerSessionV2
- DeactivateUserRequest
- DeductLoyaltyPoints
- DeductLoyaltyPointsEffectProps
- DeleteUserRequest
- Effect
- EffectEntity
- EmailEntity
- Endpoint
- Entity
- EntityWithTalangVisibleID
- Environment
- ErrorEffectProps
- ErrorResponse
- ErrorResponseWithStatus
- ErrorSource
- EvaluableCampaignIds
- Event
- EventType
- EventV2
- ExpiringCouponsNotificationPolicy
- ExpiringCouponsNotificationTrigger
- ExpiringPointsNotificationPolicy
- ExpiringPointsNotificationTrigger
- Export
- FeatureFlag
- FeaturesFeed
- FuncArgDef
- FunctionDef
- GenerateCampaignDescription
- GenerateCampaignTags
- GenerateItemFilterDescription
- GenerateLoyaltyCard
- GenerateRuleTitle
- GenerateRuleTitleRule
- GetIntegrationCouponRequest
- Giveaway
- GiveawaysPool
- IdentifiableEntity
- ImportEntity
- IncreaseAchievementProgressEffectProps
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20011
- InlineResponse20012
- InlineResponse20013
- InlineResponse20014
- InlineResponse20015
- InlineResponse20016
- InlineResponse20017
- InlineResponse20018
- InlineResponse20019
- InlineResponse2002
- InlineResponse20020
- InlineResponse20021
- InlineResponse20022
- InlineResponse20023
- InlineResponse20024
- InlineResponse20025
- InlineResponse20026
- InlineResponse20027
- InlineResponse20028
- InlineResponse20029
- InlineResponse2003
- InlineResponse20030
- InlineResponse20031
- InlineResponse20032
- InlineResponse20033
- InlineResponse20034
- InlineResponse20035
- InlineResponse20036
- InlineResponse20037
- InlineResponse20038
- InlineResponse20039
- InlineResponse2004
- InlineResponse20040
- InlineResponse20041
- InlineResponse20042
- InlineResponse20043
- InlineResponse20044
- InlineResponse20045
- InlineResponse20046
- InlineResponse20047
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- InlineResponse2008
- InlineResponse2009
- InlineResponse201
- IntegrationCoupon
- IntegrationCustomerSessionResponse
- IntegrationEntity
- IntegrationEvent
- IntegrationEventV2Request
- IntegrationProfileEntity
- IntegrationRequest
- IntegrationState
- IntegrationStateV2
- IntegrationStoreEntity
- InventoryCoupon
- InventoryReferral
- ItemAttribute
- LedgerEntry
- LedgerInfo
- LedgerPointsEntryIntegrationAPI
- LedgerTransactionLogEntryIntegrationAPI
- LibraryAttribute
- LimitConfig
- LimitCounter
- LoginParams
- Loyalty
- LoyaltyBalance
- LoyaltyBalanceWithTier
- LoyaltyBalances
- LoyaltyBalancesWithTiers
- LoyaltyCard
- LoyaltyCardBalances
- LoyaltyCardProfileRegistration
- LoyaltyCardRegistration
- LoyaltyDashboardData
- LoyaltyDashboardPointsBreakdown
- LoyaltyLedger
- LoyaltyLedgerEntry
- LoyaltyLedgerTransactions
- LoyaltyMembership
- LoyaltyProgram
- LoyaltyProgramBalance
- LoyaltyProgramEntity
- LoyaltyProgramLedgers
- LoyaltyProgramSubledgers
- LoyaltyProgramTransaction
- LoyaltySubLedger
- LoyaltyTier
- ManagementKey
- ManagerConfig
- MessageLogEntries
- MessageLogEntry
- MessageLogRequest
- MessageLogResponse
- Meta
- ModelImport
- ModelReturn
- MultiApplicationEntity
- MultipleAttribute
- MultipleAudiences
- MultipleAudiencesItem
- MultipleCustomerProfileIntegrationRequest
- MultipleCustomerProfileIntegrationRequestItem
- MultipleCustomerProfileIntegrationResponseV2
- MultipleNewAttribute
- MultipleNewAudiences
- MutableEntity
- NewAccount
- NewAccountSignUp
- NewAdditionalCost
- NewAppWideCouponDeletionJob
- NewApplication
- NewApplicationAPIKey
- NewAttribute
- NewAudience
- NewBaseNotification
- NewCampaign
- NewCampaignCollection
- NewCampaignEvaluationGroup
- NewCampaignGroup
- NewCampaignSet
- NewCampaignTemplate
- NewCatalog
- NewCollection
- NewCouponCreationJob
- NewCouponDeletionJob
- NewCoupons
- NewCouponsForMultipleRecipients
- NewCustomEffect
- NewCustomerProfile
- NewCustomerSession
- NewCustomerSessionV2
- NewEvent
- NewEventType
- NewExternalInvitation
- NewGiveawaysPool
- NewInternalAudience
- NewInvitation
- NewInviteEmail
- NewLoyaltyProgram
- NewLoyaltyTier
- NewManagementKey
- NewMultipleAudiencesItem
- NewNotificationTest
- NewNotificationWebhook
- NewOutgoingIntegrationWebhook
- NewPassword
- NewPasswordEmail
- NewPicklist
- NewReferral
- NewReferralsForMultipleAdvocates
- NewReturn
- NewRole
- NewRoleV2
- NewRuleset
- NewSamlConnection
- NewStore
- NewTemplateDef
- NewUser
- NewWebhook
- Notification
- NotificationActivation
- NotificationListItem
- NotificationTest
- OktaEvent
- OktaEventPayload
- OktaEventPayloadData
- OktaEventTarget
- OneTimeCode
- OutgoingIntegrationBrazePolicy
- OutgoingIntegrationCleverTapPolicy
- OutgoingIntegrationConfiguration
- OutgoingIntegrationIterablePolicy
- OutgoingIntegrationMoEngagePolicy
- OutgoingIntegrationTemplate
- OutgoingIntegrationTemplateWithConfigurationDetails
- OutgoingIntegrationTemplates
- OutgoingIntegrationType
- OutgoingIntegrationTypes
- PatchItemCatalogAction
- PatchManyItemsCatalogAction
- PendingPointsNotificationPolicy
- Picklist
- Product
- ProfileAudiencesChanges
- ProjectedTier
- RedeemReferralEffectProps
- Referral
- ReferralConstraints
- ReferralCreatedEffectProps
- ReferralRejectionReason
- RejectCouponEffectProps
- RejectReferralEffectProps
- RemoveFromAudienceEffectProps
- RemoveItemCatalogAction
- RemoveManyItemsCatalogAction
- ReopenSessionResponse
- ReserveCouponEffectProps
- ReturnIntegrationRequest
- ReturnedCartItem
- Role
- RoleAssign
- RoleMembership
- RoleV2
- RoleV2ApplicationDetails
- RoleV2Base
- RoleV2PermissionSet
- RoleV2Permissions
- RoleV2RolesGroup
- RollbackAddedLoyaltyPointsEffectProps
- RollbackCouponEffectProps
- RollbackDeductedLoyaltyPointsEffectProps
- RollbackDiscountEffectProps
- RollbackIncreasedAchievementProgressEffectProps
- RollbackReferralEffectProps
- Rule
- RuleFailureReason
- Ruleset
- SSOConfig
- SamlConnection
- SamlConnectionInternal
- SamlConnectionMetadata
- SamlLoginEndpoint
- ScimNewUser
- ScimResource
- ScimResourceTypesListResponse
- ScimUser
- ScimUsersListResponse
- Session
- SetDiscountEffectProps
- SetDiscountPerAdditionalCostEffectProps
- SetDiscountPerAdditionalCostPerItemEffectProps
- SetDiscountPerItemEffectProps
- ShowBundleMetadataEffectProps
- ShowNotificationEffectProps
- SlotDef
- Store
- StrikethroughChangedItem
- StrikethroughCustomEffectPerItemProps
- StrikethroughEffect
- StrikethroughLabelingNotification
- StrikethroughSetDiscountPerItemEffectProps
- StrikethroughTrigger
- TalangAttribute
- TalangAttributeVisibility
- TemplateArgDef
- TemplateDef
- TemplateLimitConfig
- Tier
- TierDowngradeNotificationPolicy
- TierUpgradeNotificationPolicy
- TierWillDowngradeNotificationPolicy
- TierWillDowngradeNotificationTrigger
- TimePoint
- TrackEventV2Response
- TransferLoyaltyCard
- TriggerWebhookEffectProps
- TwoFAConfig
- UpdateAccount
- UpdateAchievement
- UpdateApplication
- UpdateApplicationAPIKey
- UpdateAttributeEffectProps
- UpdateAudience
- UpdateCampaign
- UpdateCampaignCollection
- UpdateCampaignEvaluationGroup
- UpdateCampaignGroup
- UpdateCampaignTemplate
- UpdateCatalog
- UpdateCollection
- UpdateCoupon
- UpdateCouponBatch
- UpdateCustomEffect
- UpdateLoyaltyCard
- UpdateLoyaltyProgram
- UpdatePicklist
- UpdateReferral
- UpdateReferralBatch
- UpdateRole
- UpdateStore
- UpdateUser
- User
- UserEntity
- Webhook
- WebhookActivationLogEntry
- WebhookLogEntry
- WebhookWithOutgoingIntegrationDetails
- WillAwardGiveawayEffectProps
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header