# Campaign

Welcome to the Loyalty Program Campaigns API Documentation for Annex Cloud! This comprehensive guide is designed to empower developers, businesses, and stakeholders to seamlessly integrate and leverage our Loyalty Program Campaigns API within their applications and systems.

Our loyalty-based company understands the significance of fostering meaningful relationships with our valued customers. As such, we have crafted a powerful API that enables businesses to create, manage, and optimize loyalty campaigns, driving customer engagement, loyalty, and retention.

Annex Cloud’s Loyalty Program Campaigns API is a robust and flexible tool that facilitates the integration of our loyalty program capabilities into your applications and platforms. Through this API, you can design and execute diverse loyalty campaigns, offering tailored rewards and incentives to your customers based on their actions, purchases, or interactions with your brand.


By integrating our API, you unlock a plethora of benefits:


Customized Loyalty Campaigns: Design unique loyalty campaigns that align with your business goals and resonate with your customer base.


Enhanced Customer Engagement: Drive customer engagement by offering personalized rewards and promotions, enhancing their loyalty and advocacy.


Real-time Performance Insights: Obtain real-time analytics and insights into the performance of your loyalty campaigns, allowing you to optimize strategies for maximum effectiveness.


Seamless Integration: Easily integrate the Loyalty Program Campaigns API into your existing systems, ensuring a smooth and efficient loyalty program management process.


This documentation covers essential aspects, endpoints, request and response examples, and best practices to ensure a seamless integration and utilization of the Loyalty Program Campaigns API. Let's embark on this journey to elevate your loyalty programs and build lasting connections with your cherished customers.

## Get campaign details by User ID and either Campaign ID or Campaign Status

 - [POST /campaign](https://annexcloud.redocly.app/loyalty/loyalty/campaign/postcampaign.md): This API is used to get the campaigns details against the user & campaignID.

## Fetch Campaign Details by Campaign Status

 - [GET /campaign/{{status}}](https://annexcloud.redocly.app/loyalty/loyalty/campaign/getcampaignstatus.md): This method retrieves campaign details for campaigns based on the Campaign Status. To retrieve details for all campaigns of any status, use campaign status = all

## Fetch Campaign Details by Campaign ID

 - [GET /campaign/{{campaignId}}](https://annexcloud.redocly.app/loyalty/loyalty/campaign/getcampaigncampaignid.md): This method retrieves campaign details for a specific Campaign ID. The user must provide the Campaign ID as a key to fetch all the details of that campaign.

## Fetch Campaign Details for all Campaigns for which a member is eligible

 - [GET /users/{{memberId}}/campaign](https://annexcloud.redocly.app/loyalty/loyalty/campaign/getusersidcampaign.md): This method retrieves all active eligible campaigns for a particular member. The user needs to use a unique user ID as a key to fetch all eligible campaigns for the particular member.

## Reactivate the campaign to participate in it by using userId and campaignId details

 - [PATCH /campaign/activation/{{memberId}}](https://annexcloud.redocly.app/loyalty/loyalty/campaign/patchcampaignactivation.md): Use this PATCH campaign activation method to reactivate the campaign to participate in it. {Reactivation is required if the member receives individual validity more than one time for a campaign.}

## Activate the campaign to participate in it by using userId and campaignId details

 - [POST /campaign/activation](https://annexcloud.redocly.app/loyalty/loyalty/campaign/postcampaignactivation.md): Use this POST campaign activation method to let the member activate the campaign to participate in it.

## To set a personalized individual validity period for a member within the general campaign period

 - [POST /campaign/individualvalidity](https://annexcloud.redocly.app/loyalty/loyalty/campaign/postcampaignindividualvalidity.md): Use this POST campaign individual validity method to send individual validity for each target member in bulk.

## Fetch the Campaign Groups

 - [GET /campaign/group/{{status}}](https://annexcloud.redocly.app/loyalty/loyalty/campaign/getcampaigngroupstatus.md): This API method returns the response as per the campaign group status passed, i.e. all, active or inactive.

## Fetch details of specific Campaign Group

 - [GET /campaign/group/{{campaignGroupId}}](https://annexcloud.redocly.app/loyalty/loyalty/campaign/getcampaigngroupcampaigngroupid.md): This method allows users to retrieve detailed information about a campaign group by specifying a unique Campaign Group ID.