v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Operation for GET /v3/promotions/6903253184daf5486232dec9

Endpoint for GET /v3/promotions/6903253184daf5486232dec9

get/v3/promotions/{promotionId}

Path parameters

promotionIdstring required

Headers

Authorizationstring

Example:Basic Z2VvcmdlLmJNDkxOGFmNDI3MGQ3YzI4ZjU4ZjY3MmNhZjY1ZmY=

Cookiestring

Example:_cfuvid=FpEQ1IKxM7IelsonuP1pTGUZqKDqpA-1761801071752-0.0.1.1-604800000

Response

Successful operation (default from cURL) (Error parsing body example as JSON: Expected ',' or '}' after property value in JSON at position 25 (line 3 column 1))

string required

Raw body example due to parsing error.

Example response

"{\n  \"message\": \"Success\"\n{\n    \"data\": {\n        \"metadata\": {\n            \"name\": \"Efd Activity Based Promo\",\n            \"description\": \"Enrollment for all members, requires activity-based opt-in.\",\n            \"programId\": \"HiddenGemDefaultProgram_ID\",\n            \"orgId\": 100458,\n            \"startDate\": \"2025-11-27T00:00:00Z\",\n            \"endDate\": \"2025-12-27T23:59:59Z\",\n            \"timezoneName\": \"Asia/Kolkata\",\n            \"promotionType\": \"LOYALTY\",\n            \"status\": \"DRAFT\",\n            \"promoIdentifier\": null,\n            \"promotionId\": 0,\n            \"createdOn\": \"2025-10-30T08:43:29Z\",\n            \"lastModifiedOn\": \"2025-10-30T08:43:29Z\",\n            \"createdBy\": 0,\n            \"lastModifiedBy\": 0,\n            \"loyaltyEarningType\": null,\n            \"version\": null,\n            \"draftDetails\": null,\n            \"loyaltyConfigMetaData\": {\n                \"isStackable\": false,\n                \"isConsideredForRanking\": false,\n                \"isExclusive\": false,\n                \"isAlwaysApply\": false,\n                \"skipEarnedDateCheckOnRedeem\": null\n            },\n            \"promotionMetadata\": null,\n            \"commonStrategies\": null,\n            \"promotionMode\": \"UNIFIED\"\n        },\n        \"customerEnrolment\": {\n            \"enrolmentMethod\": \"TRANSACTION\"\n        },\n        \"activities\": [\n            {\n                \"type\": \"SINGLE\",\n                \"id\": \"activity_reward_trigger\",\n                \"type\": \"SINGLE\",\n                \"name\": \"Main Reward Activity\",\n                \"commonCycleActionMapping\": [\n                    {\n                        \"cycle\": \"cycle_promo_period\",\n                        \"actions\": [\n                            {\n                                \"id\": \"action_award_points\",\n                                \"actionName\": \"AWARD_CURRENCY\",\n                                \"actionClass\": \"com.capillary.loyalty.engine.actor.promotion.actions.AwardCurrency\",\n                                \"mandatoryPropertiesValues\": {\n                                    \"POINTS_TO_AWARD\": \"100\",\n                                    \"CURRENCY_IDENTIFIER\": \"POINTS\"\n                                }\n                            }\n                        ],\n                        \"startDate\": \"2025-11-27\",\n                        \"endDate\": \"2025-12-27\"\n                    }\n                ],\n                \"event\": \"TransactionAdd\",\n                \"allCycles\": []\n            }\n        ],\n        \"comments\": null,\n        \"parentId\": null,\n        \"parentDetails\": null,\n        \"version\": 1,\n        \"limits\": [],\n        \"liabilityOwnerSplitInfo\": [],\n        \"id\": \"6903253184daf5486232dec9\",\n        \"workflowMetadata\": {\n            \"enrolment\": {\n                \"basedOn\": null,\n                \"activities\": null,\n                \"audienceMapping\": null,\n                \"restrictions\": null\n            },\n            \"optin\": {\n                \"basedOn\": \"ACTIVITY\",\n                \"audienceMapping\": null,\n                \"activities\": [\n                    {\n                        \"type\": \"SINGLE\",\n                        \"id\": \"activity_optin_trigger\",\n                        \"type\": \"SINGLE\",\n                        \"name\": \"Opt-in Trigger Activity\",\n                        \"event\": \"TransactionAdd\",\n                        \"allCycles\": []\n                    }\n                ],\n                \"restrictions\": null\n            }\n        },\n        \"communicationApprovalStatus\": null\n    },\n    \"errors\": null,\n    \"warnings\": null\n}"