post https://{host}/api_gateway/v1/badges/customer/earn
This API allows you to issue badges to the customer (the customer earns the badge).
Note
- For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
- A badge can be issued via MemberCare without any owners or claim.
Prerequisites
- Authentication: Basic authentication
- Default access group
Resource information
| URI | /api_gateway/v1/badges/customer/earn |
| HTTP method | POST |
| Pagination | No |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/customer/earn
Request body parameters
| Parameter | Data Type | Description |
|---|---|---|
| badgeMetaId | String | Unique identifier ("id") generated during the creation of the badge. |
| customerId* | Number | Unique identifier for the customer. |
| requestId* | String | Enter a unique identifier to identify the request. |
| earnEventDate | Date | The date on which the customer performed the activity. Earn event date has to be between the badge start date and end date if it is a direct earn type of badge and it has to be between the badge issual start date and end date if it is an issue & earn type of badge. You can also enter a past date. This can be used to issue a badge against an older transaction. |
| triggeredBy | Object | The object containing information about what triggered the action. |
| ownerType* | Enum | The module for which the badge is being issued. Supported values: LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/ REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES. |
| referenceId* | String | Enter a unique identifier to identify the owner (ownerType). The referenceId passed here should be the same as the referenceId in the claim badge API. |
{
"badgeMetaId": "66276dc68fe258516a88ff8e",
"earnEventDate":"2023-11-03T21:51:00.192Z",
"customerId": 62090013,
"requestId": 2132,
"triggeredBy": {
"ownerType": "Loyalty",
"referenceId": "123694"
}
}
Reponse parameters
| Parameter | Data Type | Description |
|---|---|---|
| badgeMetaId | String | Unique identifier for the badge metadata. |
| customerId | Number | Unique identifier for the customer. |
| earnedBadgeId | String | Unique identifier for the earned badge. |
| expiresOn | Number | The time indicating when the badge expires. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ. |
| errors | Array | Array to list any errors. |
| warnings | Array | Array to list any warnings. |
{
"data": {
"badgeMetaId": "66276dc68fe258516a88ff8e",
"customerId": 62090013,
"earnedBadgeId": "662771bd8fe258516a88ff98",
"expiresOn": 1715070653.447744000,
"requestId": 2131
},
"errors": [],
"warnings": []
}
API-specific error codes
| Error code | Description |
|---|---|
| 809 | Request with the same requestId is not allowed |
| 811 | Badge issue is mandatory before earn |