API Documentation
Member API
Reward API
Partnerships
Webhooks
Get Campaign
Copy
Ask AI
curl --request GET \
--url https://campaignservice-staging.withbenji.com/campaigns/{id} \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"code": "ok",
"data": {
"campaign": {
"base_reward": 1,
"campaign_logo": "testcampaign.png",
"campaign_type": 1,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"description": "This is a test campaign",
"end_date": null,
"id": 1,
"is_active": 1,
"is_deleted": 0,
"merchant_id": 1,
"name": "Test Campaign",
"owner_id": 5,
"partner_id": 3,
"start_date": "2024-11-14T03:18:06+00:00",
"total_rewards": 100,
"trigger_type": 1
}
}
}
Get Campaign
Endpoint to retrieve campaign basic data
GET
https://campaignservice-staging.withbenji.com
/
campaigns
/
{id}
Get Campaign
Copy
Ask AI
curl --request GET \
--url https://campaignservice-staging.withbenji.com/campaigns/{id} \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"code": "ok",
"data": {
"campaign": {
"base_reward": 1,
"campaign_logo": "testcampaign.png",
"campaign_type": 1,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"description": "This is a test campaign",
"end_date": null,
"id": 1,
"is_active": 1,
"is_deleted": 0,
"merchant_id": 1,
"name": "Test Campaign",
"owner_id": 5,
"partner_id": 3,
"start_date": "2024-11-14T03:18:06+00:00",
"total_rewards": 100,
"trigger_type": 1
}
}
}
The
x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.The Benji Platform ID of the campaign
Return values
A campaign object property
Hide properties
Hide properties
Benji Platform campaign identifier
The campaign display name as configured on the Benji Platform
The campaign’s description as configured on the Benji platform
URL of a marketing logo associated with the campaign
Integer representing an enum of one of the following campaign type values :
Show possible campaign type values
Show possible campaign type values
- EARN (1) : Indicating an earn rewards campaign type
- REDEEM (2) : Indicating a redeem rewards campaign type
- CONNECT_ONLY (3) : Indicating a status sharing campaign with no ability to earn or redeem rewards
Integer representing an enum of one of the following campaign trigger values :
Show possible trigger type values
Show possible trigger type values
- SPEND (1) : Indicating a campaign triggered on a transaction
- REGISTRATION (2) : Indicating a campaign triggered on a new user registration
- REFERRAL (3) : Indicating a campaign triggered on a succesful user referral action
- CUSTOM (3) : Indicating a campaign triggered by a custom action
The ID of the merchant partner associated with this campaign in the Benji Platform
The ID of the partner associated with this campaign in the Benji Platform
The base reward conversion rate for earn and redeem type campaigns
The date this campaign will go live
The date this campaign will end
The total amount of rewards earned or redeemed through this campaign
Integer indicating if this campaign has been activated, 1 specifying active and 0 specifying not active
Copy
Ask AI
{
"code": "ok",
"data": {
"campaign": {
"base_reward": 1,
"campaign_logo": "testcampaign.png",
"campaign_type": 1,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"description": "This is a test campaign",
"end_date": null,
"id": 1,
"is_active": 1,
"is_deleted": 0,
"merchant_id": 1,
"name": "Test Campaign",
"owner_id": 5,
"partner_id": 3,
"start_date": "2024-11-14T03:18:06+00:00",
"total_rewards": 100,
"trigger_type": 1
}
}
}
Note that you will only receive data that you as a loyalty patner or merchant partner are allowed to see based on the permissions in the access token you provide to the API
Was this page helpful?
⌘I