# Masivo

## Docs

- [Authorize](https://docs.masivo.ai/api-reference/auth/authorize/get.md): Get an Access token to be able to call the api. This token should be kept secret and not exposed to the client.
- [Request TOTP](https://docs.masivo.ai/api-reference/auth/totp/post.md): Some applications may need customers to authorize other systems on their behalf. With the 'totp' endpoint, customers can request a temporal code that other systems can use to confirm the customer identity.
- [Verify TOTP](https://docs.masivo.ai/api-reference/auth/totp/verify/get.md): Verify the TOTP token, if valid return matching customer
- [Fulfill event](https://docs.masivo.ai/api-reference/behavior/events/[eventId]/fulfill/patch.md): Fulfill a behavior event. This will redeem the event rewards and offer campaign rewards to the customer.
- [Reverse event](https://docs.masivo.ai/api-reference/behavior/events/[eventId]/reverse/delete.md): Reverse the given event. This will also undo the redemptions and accumulations made on the event.
- [Emit event](https://docs.masivo.ai/api-reference/behavior/events/post.md): Create a behavior event. This will trigger matching campaigns to offer rewards to the customer.
- [Get brands](https://docs.masivo.ai/api-reference/brands/get.md): Get all brands
- [Get campaign](https://docs.masivo.ai/api-reference/campaigns/[id]/get.md): Get a specific campaign
- [Get campaigns](https://docs.masivo.ai/api-reference/campaigns/get.md): Get all campaigns
- [Create a new campaign](https://docs.masivo.ai/api-reference/campaigns/post.md): Create a campaign
- [Delete contact by ID](https://docs.masivo.ai/api-reference/contacts/[id]/delete.md): Delete a contact by its unique identifier (UID). This performs a soft delete by setting the deleted_at timestamp.
- [Update contact by ID](https://docs.masivo.ai/api-reference/contacts/[id]/put.md): Update a contact by its unique identifier (ID). This allows partial updates of contact information.
- [Search contacts](https://docs.masivo.ai/api-reference/contacts/get.md): Search for contacts using specific criteria. This endpoint allows you to find contacts by their unique identifiers: external ID, email, or document number. At least one of these three fields is required.
- [Migrate contacts](https://docs.masivo.ai/api-reference/contacts/migrate/post.md): Migrate contacts in bulk from an external system to Masivo. This endpoint allows you to import up to 10,000 contacts at once.
- [Create contact](https://docs.masivo.ai/api-reference/contacts/post.md): Create a new contact. This endpoint allows you to create contacts by their unique identifiers: external ID, email, or document number. At least one of these three fields is required.
- [Redeem coupon](https://docs.masivo.ai/api-reference/coupons/redeem/post.md): Redeem a coupon code
- [Reverse coupon](https://docs.masivo.ai/api-reference/coupons/reverse/post.md): Reverse a coupon redemption and remove rewards from customer's wallet
- [Get customer consent](https://docs.masivo.ai/api-reference/customers/[id]/consent/get.md): Get customer consent preferences. If consent is null or empty, the API returns default consent values with all purposes set to true.
- [Update customer consent](https://docs.masivo.ai/api-reference/customers/[id]/consent/patch.md): Update customer consent preferences according to IAB TCF (Transparency and Consent Framework) standards.
- [Unregister customer](https://docs.masivo.ai/api-reference/customers/[id]/delete.md): Delete a customer by id
- [Customer device token](https://docs.masivo.ai/api-reference/customers/[id]/devices/delete.md): Unregister customer's device token.
- [Customer device token](https://docs.masivo.ai/api-reference/customers/[id]/devices/patch.md): Update customer's device token.
- [Get customer](https://docs.masivo.ai/api-reference/customers/[id]/get.md): Get a customer by id
- [Identify anonymous customers](https://docs.masivo.ai/api-reference/customers/[id]/identify/anonymous/patch.md): Identify an anonymous customer by providing their real information. This endpoint converts an anonymous customer to a regular customer. The customer must have been created with `is_anonymous: true`. Optionally, you can provide a `new_id` to change the customer's ID during identification.
- [Update customer](https://docs.masivo.ai/api-reference/customers/[id]/patch.md): Update a customer by id. Only some fields can be updated using these API.
- [Get customer punch-cards](https://docs.masivo.ai/api-reference/customers/[id]/punch-cards/get.md): Get punch cards of a customer. By default, only returns ACTIVE punch cards.
- [Request referral code](https://docs.masivo.ai/api-reference/customers/[id]/referrals/request-code/post.md): Request a unique referral code for a customer. If the customer already has a code for this campaign, the existing code will be returned.
- [Delete customer tags](https://docs.masivo.ai/api-reference/customers/[id]/tags/delete.md): You can delete multiple tags from a customer at once.
- [Update customer tags](https://docs.masivo.ai/api-reference/customers/[id]/tags/patch.md): You can upsert multiple tags from a customer at once.
- [Customer transactions](https://docs.masivo.ai/api-reference/customers/[id]/transactions/get.md): Get transactions of a customer. By default it returns the transactions of the last 3 months.
- [Fulfill expired events](https://docs.masivo.ai/api-reference/customers/fulfill_expired_events/post.md): Fulfill expired events that were not marked as fulfilled. This endpoint enqueues up to 500 events per call to be processed in the background. Note that events may fail due to expired rewards or insufficient wallet balance at the time of re-processing them. Failed events can be reviewed in the Cron J…
- [Migrate devices tokens](https://docs.masivo.ai/api-reference/customers/migrate/devices/post.md): Migrate device tokens from an old system to Masivo
- [Migrate events](https://docs.masivo.ai/api-reference/customers/migrate/events/post.md): Migrate events from an old system to Masivo
- [Migrate customers](https://docs.masivo.ai/api-reference/customers/migrate/post.md): Migrate a customer from an old system to Masivo
- [Revert migration](https://docs.masivo.ai/api-reference/customers/migrate/revert/delete.md): Revert all customers migration that don't have new transactions
- [Migrate transactions](https://docs.masivo.ai/api-reference/customers/migrate/transactions/post.md): Migrate transactions from an old system to Masivo
- [Register customer](https://docs.masivo.ai/api-reference/customers/post.md): Register a customer. For anonymous customers, only the `id` and `is_anonymous: true` are required. Anonymous customers can later be identified using the `/customers/{id}/identify/anonymous` endpoint.
- [Identify customer](https://docs.masivo.ai/api-reference/events/identify/patch.md): Link a customer with a tracking ID to establish analytics relationships.
- [Preview order](https://docs.masivo.ai/api-reference/events/redeem/preview/put.md): Preview the order as if the given rewards were redeemed
- [Attribution Tracking](https://docs.masivo.ai/api-reference/guides/attribution-tracking.md): Complete guide for implementing attribution tracking in Masivo - understand attribution parameters, tracking IDs, and how to measure campaign effectiveness across all customer touchpoints
- [Customer Audience Enrollment](https://docs.masivo.ai/api-reference/guides/customer-audience-enrollment.md): Complete guide for managing customer tags and audience enrollment in Masivo - from tag assignment to automatic audience segmentation
- [FCM Token Management](https://docs.masivo.ai/api-reference/guides/fcm-token-management.md): Complete guide for managing Firebase Cloud Messaging (FCM) tokens in Masivo - from user registration to token expiration and unregistration
- [Integrate push notifications](https://docs.masivo.ai/api-reference/guides/integrate-push-notification.md): Learn how to register device tokens for push notifications using Masivo's REST API
- [Integrate with Masivo](https://docs.masivo.ai/api-reference/guides/integrate-with-masivo.md): Learn how to integrate Masivo with your e-commerce platforms
- [Journey Triggers](https://docs.masivo.ai/api-reference/guides/journey-triggers.md): Complete guide for triggering automated customer journeys in Masivo using events - from cart abandonment to personalized follow-ups
- [Migrate customers](https://docs.masivo.ai/api-reference/guides/migrate-customers.md): Learn how to migrate customers from your old system using Masivo's REST API
- [Modify customer balance arbitrarily](https://docs.masivo.ai/api-reference/guides/modify-customer-balance-arbitrarily.md): Learn how to modify wallets arbitrarily using Masivo's REST API
- [Redeem a coupon](https://docs.masivo.ai/api-reference/guides/redeem-a-coupon.md): Learn how to redeem a coupon using Masivo's REST API
- [Register a customer](https://docs.masivo.ai/api-reference/guides/register-a-customer.md): Learn how to register a customer using Masivo's REST API
- [Reverse a coupon](https://docs.masivo.ai/api-reference/guides/reverse-a-coupon.md): Learn how to reverse a coupon redemption using Masivo's REST API
- [Send an event](https://docs.masivo.ai/api-reference/guides/send-an-event.md): Learn how to send an event to Masivo's REST API
- [Setup webhooks](https://docs.masivo.ai/api-reference/guides/setup-webhooks.md): Learn how to set up webhooks in Masivo to receive notifications about events, rewards, and more
- [Show customer data](https://docs.masivo.ai/api-reference/guides/show-customer-data.md): Learn how to show your customers data using Masivo's REST API
- [Validate rewards redemption](https://docs.masivo.ai/api-reference/guides/validate-rewards-redemption.md): Learn how to preview & validate rewards redemptions
- [Introduction](https://docs.masivo.ai/api-reference/introduction.md): Learn how to integrate your services with Masivo's REST API
- [Get platforms](https://docs.masivo.ai/api-reference/platforms/get.md): Get all platforms
- [Resource limits](https://docs.masivo.ai/api-reference/resources/resource-limits.md): Learn about resource limits in Masivo and how it applies to different environments and endpoints
- [Get reward](https://docs.masivo.ai/api-reference/rewards/[id]/get.md): Get a specific reward
- [Get rewards](https://docs.masivo.ai/api-reference/rewards/get.md): Get all rewards
- [Get customer gift cards](https://docs.masivo.ai/api-reference/rewards/gift-cards/get.md): Get customer gift cards
- [Redeem gift card](https://docs.masivo.ai/api-reference/rewards/gift-cards/redeem/delete.md): Mark a gift card as redeemed
- [Create a new reward](https://docs.masivo.ai/api-reference/rewards/post.md): Create a reward
- [Get tiers](https://docs.masivo.ai/api-reference/tiers/get.md): Get all tiers
- [Account transactions](https://docs.masivo.ai/api-reference/transactions/get.md): Get account transactions by date. Maximum 1000 rows per request. Without the cursor query parameter, the response is the first 1000 records. Paginate with optional cursor.
- [Automate customer lifecycle](https://docs.masivo.ai/case/automate-customer-lifecycle.md): Learn how to automate the customer lifecycle using Masivo
- [Get to know your customers](https://docs.masivo.ai/case/get-to-know-your-customers.md): Masivo is a powerful tool to get to know your customers better. Learn how to use it to improve your business.
- [Improve RFM score](https://docs.masivo.ai/case/improve-rfm-score.md): Learn how to improve your RFM score using Masivo
- [Increase customer engagement](https://docs.masivo.ai/case/increase-customer-engagement.md): Using Masivo you can increase customer engagement, learn how to use it to improve your business.
- [Reduce customer churn](https://docs.masivo.ai/case/reduce-customer-churn.md): Learn how to reduce customer churn using Masivo
- [Segment customers](https://docs.masivo.ai/case/segment-customers.md): Learn how to segment your customers using Masivo
- [Comparison](https://docs.masivo.ai/comparison.md): Compare Masivo's features and capabilities with other loyalty platforms
- [Brands](https://docs.masivo.ai/concepts/brands.md): Learn what brands are and how they can help you create a successful loyalty program.
- [Campaigns](https://docs.masivo.ai/concepts/campaigns.md): Learn what campaigns are and how they can help you create a successful loyalty program.
- [Channels](https://docs.masivo.ai/concepts/channels.md): Learn what channels are and how they can help you create a successful loyalty program.
- [Customers](https://docs.masivo.ai/concepts/customers.md): Learn what customers are in Masivo.
- [Customer events](https://docs.masivo.ai/concepts/events.md): Learn what events  are in Masivo.
- [Index](https://docs.masivo.ai/concepts/index.md): Learn about the main concepts behind Masivo and how they can help you create a successful loyalty program.
- [Products](https://docs.masivo.ai/concepts/products.md): Learn what products are in Masivo.
- [Rewards](https://docs.masivo.ai/concepts/rewards.md): Learn what rewards are and how they can help you create a successful loyalty program.
- [Stores](https://docs.masivo.ai/concepts/stores.md): Learn what stores are and how they can help you create a successful loyalty program.
- [Tiers](https://docs.masivo.ai/concepts/tiers.md): Learn what tiers are and how they can help you create a successful loyalty program.
- [Transactions](https://docs.masivo.ai/concepts/transactions.md): Learn what transactions are in Masivo.
- [Wallets](https://docs.masivo.ai/concepts/wallets.md): Learn what wallets are in Masivo.
- [Customers](https://docs.masivo.ai/guides/CDP/customers.md): Understanding how customers and contacts work together in Masivo's Customer Data Platform
- [Events](https://docs.masivo.ai/guides/CDP/events.md): Understanding how events work in Masivo's Customer Data Platform
- [Overview](https://docs.masivo.ai/guides/CDP/integrations.md): Connect third-party tools to sync data from Masivo's Customer Data Platform
- [Amazon S3](https://docs.masivo.ai/guides/CDP/integrations/amazon-s3/overview.md): Learn how to integrate Amazon S3 with Masivo CDP for data export and analytics
- [Braze](https://docs.masivo.ai/guides/CDP/integrations/braze/overview.md): Learn how to integrate Braze with Masivo CDP for seamless customer data synchronization
- [Facebook Apps Events](https://docs.masivo.ai/guides/CDP/integrations/facebook-apps-events/overview.md): Learn how to integrate Facebook Apps Events with Masivo CDP for mobile app event tracking and conversion optimization
- [Facebook Audiences](https://docs.masivo.ai/guides/CDP/integrations/facebook-audiences/overview.md): Learn how to integrate Facebook Custom Audiences with Masivo CDP for targeted advertising campaigns
- [Facebook Pixel](https://docs.masivo.ai/guides/CDP/integrations/facebook-pixel/overview.md): Learn how to integrate Facebook Pixel with Masivo CDP for enhanced conversion tracking and customer insights
- [Google Ads](https://docs.masivo.ai/guides/CDP/integrations/google-ads/overview.md): Learn how to integrate Google Ads with Masivo CDP for conversion tracking and campaign optimization
- [Google Analytics](https://docs.masivo.ai/guides/CDP/integrations/google-analytics/overview.md): Learn how to integrate Google Analytics 4 with Masivo CDP for comprehensive event tracking and customer insights
- [TikTok](https://docs.masivo.ai/guides/CDP/integrations/tiktok/overview.md): Learn how to integrate TikTok Events API with Masivo CDP for conversion tracking and ad optimization
- [Overview](https://docs.masivo.ai/guides/CDP/overview.md): Transform your customer data into a unified, actionable view with Masivo's Customer Data Platform
- [Smart Menu](https://docs.masivo.ai/guides/CDP/smart-menu.md): Personalized product recommendations based on customer preferences and behavior
- [Onboarding](https://docs.masivo.ai/guides/CDP/unify/onboarding.md): Your first steps into unified customer identity
- [Overview](https://docs.masivo.ai/guides/CDP/unify/overview.md): Unified customer identity management across multiple data sources
- [Accumulating rewards](https://docs.masivo.ai/guides/accumulating-rewards.md): Learn how customers can accumulate rewards
- [Create templates](https://docs.masivo.ai/guides/content-templates.md): Learn how to create template in Masivo
- [Create audiences](https://docs.masivo.ai/guides/create-audiences.md): Learn how to create and manage dynamic customer audiences in Masivo
- [Journeys](https://docs.masivo.ai/guides/create-journeys.md): Learn how to create and manage automated customer journeys in Masivo
- [Links](https://docs.masivo.ai/guides/create-links.md): Learn how to create and manage links in Masivo marketing automation
- [Push notifications](https://docs.masivo.ai/guides/create-push.md): Learn how to create and manage push notification templates in Masivo
- [Create rewards](https://docs.masivo.ai/guides/create-rewards.md): Learn how to create rewards in Masivo
- [WhatsApp templates](https://docs.masivo.ai/guides/create-whatsapp.md): Learn how to create and manage WhatsApp templates in Masivo
- [Create your first account](https://docs.masivo.ai/guides/create-your-first-account.md): Learn how to create your first account in Masivo
- [Best practices](https://docs.masivo.ai/guides/emails/best-practices.md): Follow these deliverability best practices to ensure your emails reach the inbox
- [Creating an email template](https://docs.masivo.ai/guides/emails/create-email.md): Learn how to create and manage email templates in Masivo
- [Unsubscribe links](https://docs.masivo.ai/guides/emails/unsubscribe-links.md): Understand why including dynamic unsubscribe links is essential for compliance and deliverability
- [Launch a campaign](https://docs.masivo.ai/guides/launch-a-campaign.md): Learn how to launch a campaign in Masivo
- [General](https://docs.masivo.ai/guides/marketing-automations.md): Learn what marketing automation is and how it can transform your customer engagement
- [Next steps](https://docs.masivo.ai/guides/next-steps.md): Learn what to do next after setting up your account
- [Purchase Attribution System](https://docs.masivo.ai/guides/purchase-attribution.md): Complete guide to implementing and understanding Masivo's purchase attribution system - track marketing campaign effectiveness, loyalty program impact, and measure ROI across all customer touchpoints
- [Redeeming rewards](https://docs.masivo.ai/guides/redeeming-rewards.md): Learn how customers can redeem rewards
- [Email settings](https://docs.masivo.ai/guides/settings/email.md): Configure email domains, footer templates, and tracking options for email templates
- [Links settings](https://docs.masivo.ai/guides/settings/links.md): Configure link settings for domains, redirects, app store metadata, and QR branding
- [Marketing automation settings](https://docs.masivo.ai/guides/settings/marketing-automation.md): Configure Links, Email, Push, and WhatsApp settings for marketing automation in Masivo
- [Push settings](https://docs.masivo.ai/guides/settings/push.md): Configure Firebase credentials and token policies for push notifications
- [WhatsApp settings](https://docs.masivo.ai/guides/settings/whatsapp.md): Configure WhatsApp credentials, webhook URL, and business logo for template delivery
- [Setup a Tier System](https://docs.masivo.ai/guides/setup-a-tier-system.md): Learn how to set up a tiers system in Masivo
- [Manage and track customers](https://docs.masivo.ai/guides/track-customer-activity.md): Learn how to manage and track customer activity in Masivo
- [Using template variables](https://docs.masivo.ai/guides/using-template-variables.md): Learn what variables are and how they help personalize email, push, and WhatsApp templates
- [Braze integration](https://docs.masivo.ai/integrations/braze.md): Sync Masivo customers, events, purchases and audiences to Braze
- [Google Ads integration](https://docs.masivo.ai/integrations/google-ads.md): Track and send conversion data from Masivo to Google Ads
- [Google Analytics 4 integration](https://docs.masivo.ai/integrations/google-analytics.md): Sync Masivo customers, events, and audiences to Google Analytics 4
- [Integrations](https://docs.masivo.ai/integrations/index.md): Connect third‑party tools to sync data from Masivo
- [TikTok Events API integration](https://docs.masivo.ai/integrations/tiktok.md): Sync Masivo customers, events, and conversions to TikTok for ad optimization
- [Masivo](https://docs.masivo.ai/overview.md): Welcome to Masivo's documentation!
- [Quickstart](https://docs.masivo.ai/quickstart.md): Configure your loyalty program in under 5 minutes

## OpenAPI Specs

- [openapi](https://docs.masivo.ai/api-reference/openapi.json)
- [package](https://docs.masivo.ai/package.json)
- [settings](https://docs.masivo.ai/.vscode/settings.json)

## Optional

- [Roadmap](https://docs.masivo.ai/roadmap)
- [Changelog](https://docs.masivo.ai/changelog)
- [Community](https://discord.gg/2DgqGUej)