Introduction Ask Anything

Sample Campaigns

EASY-DISCOUNT: Always 10% off

10% on Transaction Copy

EASY-DISCOUNT: 20% off when session value greater than $200

20% on transaction over 200

EASY-COUPON: 30% off with coupon code

30% off with coupon code

EASY-DISCOUNT: Specific discounts on categories

Specific discounts on categories

MEDIUM-LOYALTY: Collect 1 point per $ spent

Collect 1 point per $ spent

MEDIUM-LOYALTY: Spend 1 point as 1$

Spend 1 point as 1$

MEDIUM-REFERRAL: Generate and redeem a referral code

Customer registers Friend uses referral code

ADVANCED-BUNDLE: $50 off bundled products

$50 off bundled products

ADVANCED-GAMIFICATION: Spend more than $300 3 times and get 1000 points

3nd transaction above $300

⭐️ Third-party API

Create referral Create coupon Create coupon reservation Track event

Customer data platforms

Update customer profile Create audience Update audience Update audiences in multiple customer profiles Delete audience

Customer engagement platforms

Create coupon Create referral Get loyalty ledger Add loyalty points

Create coupon Create referral Get loyalty ledger

Segment-Deprecated endpoints

Upsert customer profile Upsert customer profile V2 Track event Update customer session

Update customer profile Track event Update audiences in multiple customer profiles Update customer session Create audience Update audience Delete audience

🔎 Management API

Accounts and users

List users in account Get user Update user Delete user Validate Okta API ownership List SCIM users Create SCIM user Get SCIM user Delete SCIM user Update SCIM user Update SCIM user attributes List supported SCIM resource types Service config endpoint for SCIM provisioning protocol List supported SCIM schemas Delete user by email address Enable user by email address Disable user by email address Invite user from identity provider Invite user Resend invitation email Request a password reset Reset password Get account details Get account analytics

Create achievement List achievements Export achievement customer data Update achievement Delete achievement List customer achievements

Additional costs

Create additional cost List additional costs Get additional cost Update additional cost

Export triggered effects Export customer sessions

List Applications Get Application Get Application health

Create custom attribute List custom attributes Get custom attribute Update custom attribute Import allowed values for attribute

List audiences List audience analytics List audience members Import audience members Export audience members

Campaign access groups

List campaign access groups Get campaign access group

Campaign templates

List campaign templates Create campaign from campaign template

List campaigns Get campaign Update campaign Delete campaign Copy the campaign into the specified Application List campaigns that match the given attributes List campaign rulesets Get ruleset Get analytics of campaigns

List items in catalog

List collections in account Create account-level collection Get account-level collection Update account-level collection Delete account-level collection Get collection items List collections in Application List collections in campaign Create campaign-level collection Get campaign-level collection Update campaign-level collection's description Delete campaign-level collection Import data into existing account-level collection Import data into existing campaign-level collection Export account-level collection's items Export campaign-level collection's items

Create coupons Update coupons Delete coupons Create coupons for multiple recipients Create coupons asynchronously List coupons Update coupon Delete coupon List coupons that match the given attributes in campaign (without total count)List coupons that match the given attributes (without total count)Import coupons Export coupons

List application's customers List application customers matching the given attributes List customer profiles matching the given attributes Get customer profile List customer profiles Get application's customer Get Activity Reports for Application Customers Get customer's activity report Get customer's analytics report List Application sessions Get Application session List Applications events List Applications event types

List event types

Import giveaway codes into a giveaway pool Export giveaway codes of a giveaway pool

Get access logs for Application List access logs List webhook activation log entries List webhook log entries Get audit logs for an account Get exports

List loyalty programs Get loyalty program Import loyalty points Import customers into loyalty tiers Get customer's full loyalty ledger Add points to customer profile Deduct points from customer profile Export customer's transaction logs Export customers' tier data Get loyalty program statistics Export customer loyalty balances List loyalty program transactions

Import loyalty cards Export all card transaction logs List loyalty cards Delete loyalty card Update loyalty card status Get loyalty card Add points to card Deduct points from card Export card's ledger log List card's transactions Transfer card data

Activate or deactivate notification Create notification about added or deducted loyalty points Create notification about pending loyalty points Create strikethrough notification

Delete referral Update referral List referrals List friends referred by customer profile Export referrals Import referrals

List roles Get role Update role

Create session Destroy session

List stores Create store Get store Update store Delete store Export stores Disconnect stores Import stores

List webhooks Get webhook

🚀 Integration API

Create audience Delete audience Update audience name Delete audience memberships Update multiple customer profiles' audiences Update profile attributes for all customers in audience

Sync cart item catalog

Create coupon reservation Delete coupon reservations List customers that have this coupon reserved

Customer profiles

Update customer profile Update multiple customer profiles Delete customer's personal data List customer data

Customer sessions

Update customer session Get customer session Return cart items Reopen customer session

Get customer's loyalty points List customer's unused loyalty points

Link customer profile to card Get card's point balances List card's unused loyalty points

Create referral code for an advocate Create referral codes for multiple advocates

Introduction Ask Anything

Sample Campaigns

EASY-DISCOUNT: Always 10% off

10% on Transaction Copy

EASY-DISCOUNT: 20% off when session value greater than $200

20% on transaction over 200

EASY-COUPON: 30% off with coupon code

30% off with coupon code

EASY-DISCOUNT: Specific discounts on categories

Specific discounts on categories

MEDIUM-LOYALTY: Collect 1 point per $ spent

Collect 1 point per $ spent

MEDIUM-LOYALTY: Spend 1 point as 1$

Spend 1 point as 1$

MEDIUM-REFERRAL: Generate and redeem a referral code

Customer registers Friend uses referral code

ADVANCED-BUNDLE: $50 off bundled products

$50 off bundled products

ADVANCED-GAMIFICATION: Spend more than $300 3 times and get 1000 points

3nd transaction above $300

⭐️ Third-party API

Create referral Create coupon Create coupon reservation Track event

Customer data platforms

Update customer profile Create audience Update audience Update audiences in multiple customer profiles Delete audience

Customer engagement platforms

Create coupon Create referral Get loyalty ledger Add loyalty points

Create coupon Create referral Get loyalty ledger

Segment-Deprecated endpoints

Upsert customer profile Upsert customer profile V2 Track event Update customer session

Update customer profile Track event Update audiences in multiple customer profiles Update customer session Create audience Update audience Delete audience

🔎 Management API

Accounts and users

List users in account Get user Update user Delete user Validate Okta API ownership List SCIM users Create SCIM user Get SCIM user Delete SCIM user Update SCIM user Update SCIM user attributes List supported SCIM resource types Service config endpoint for SCIM provisioning protocol List supported SCIM schemas Delete user by email address Enable user by email address Disable user by email address Invite user from identity provider Invite user Resend invitation email Request a password reset Reset password Get account details Get account analytics

Create achievement List achievements Export achievement customer data Update achievement Delete achievement List customer achievements

Additional costs

Create additional cost List additional costs Get additional cost Update additional cost

Export triggered effects Export customer sessions

List Applications Get Application Get Application health

Create custom attribute List custom attributes Get custom attribute Update custom attribute Import allowed values for attribute

List audiences List audience analytics List audience members Import audience members Export audience members

Campaign access groups

List campaign access groups Get campaign access group

Campaign templates

List campaign templates Create campaign from campaign template

List campaigns Get campaign Update campaign Delete campaign Copy the campaign into the specified Application List campaigns that match the given attributes List campaign rulesets Get ruleset Get analytics of campaigns

List items in catalog

List collections in account Create account-level collection Get account-level collection Update account-level collection Delete account-level collection Get collection items List collections in Application List collections in campaign Create campaign-level collection Get campaign-level collection Update campaign-level collection's description Delete campaign-level collection Import data into existing account-level collection Import data into existing campaign-level collection Export account-level collection's items Export campaign-level collection's items

Create coupons Update coupons Delete coupons Create coupons for multiple recipients Create coupons asynchronously List coupons Update coupon Delete coupon List coupons that match the given attributes in campaign (without total count)List coupons that match the given attributes (without total count)Import coupons Export coupons

List application's customers List application customers matching the given attributes List customer profiles matching the given attributes Get customer profile List customer profiles Get application's customer Get Activity Reports for Application Customers Get customer's activity report Get customer's analytics report List Application sessions Get Application session List Applications events List Applications event types

List event types

Import giveaway codes into a giveaway pool Export giveaway codes of a giveaway pool

Get access logs for Application List access logs List webhook activation log entries List webhook log entries Get audit logs for an account Get exports

List loyalty programs Get loyalty program Import loyalty points Import customers into loyalty tiers Get customer's full loyalty ledger Add points to customer profile Deduct points from customer profile Export customer's transaction logs Export customers' tier data Get loyalty program statistics Export customer loyalty balances List loyalty program transactions

Import loyalty cards Export all card transaction logs List loyalty cards Delete loyalty card Update loyalty card status Get loyalty card Add points to card Deduct points from card Export card's ledger log List card's transactions Transfer card data

Activate or deactivate notification Create notification about added or deducted loyalty points Create notification about pending loyalty points Create strikethrough notification

Delete referral Update referral List referrals List friends referred by customer profile Export referrals Import referrals

List roles Get role Update role

Create session Destroy session

List stores Create store Get store Update store Delete store Export stores Disconnect stores Import stores

List webhooks Get webhook

🚀 Integration API

Create audience Delete audience Update audience name Delete audience memberships Update multiple customer profiles' audiences Update profile attributes for all customers in audience

Sync cart item catalog

Create coupon reservation Delete coupon reservations List customers that have this coupon reserved

Customer profiles

Update customer profile Update multiple customer profiles Delete customer's personal data List customer data

Customer sessions

Update customer session Get customer session Return cart items Reopen customer session

Get customer's loyalty points List customer's unused loyalty points

Link customer profile to card Get card's point balances List card's unused loyalty points

Create referral code for an advocate Create referral codes for multiple advocates

Home 🔎 Management API Accounts and usersDisable user by email address

Disable user by email address

POST {{baseUrl}}/v1/users/deactivate

Disable a specific user by their email address.

Request Body

{"email"=>"john.doe@example.com"}

Enable user by email address

Invite user from identity provider