Issue badge (earn)

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 or OAuth authentication
Default access group

Resource information


URI	/api_gateway/v1/badges/customer/earn
HTTP method	POST
Pagination	No
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	Defines the date on which the customer performed the activity. This date can be set up to 24 hours in the future from the current time, which allows badges to be earned based on when the customer's action occurred, not just when the system processes it. The earn event date has to be between the badge start date and end date if it is a direct earn type of badge. The earn event date has to be set between the badge issual start date and end date if it is an issue & earn type of badge. You can enter a past date to issue a badge against an older transaction.
earnEventDateISO	String	Defines the date on which the customer performed the activity in ISO 8601 format in UTC and is independent of the user’s local time zone. For example: The activity was performed at 11:20:00 on March 15, 2026. Format for the request parameter: 2026-03-15T11:20:00Z Notes: This date can be set up to 24 hours in the future from the current time. For direct earn badges, the date must be between the badge start and end date. For issue & earn badges, the date must be between the badge issual start and end date. A past date can be entered to issue a badge against an older transaction. Only if `earnEventDateISO` is null, `earnEventDate` parameter will be used. Time format: ISO 8601 time format eg. "2025-09-10T15:00:00+05:30
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, Loyalty_Promotion, Referral_Campaigns, Journeys, Audience_Campaigns, Rewards_Catalog, Goodwill_Module, Milestones, Historical_Import
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",
    "earnEventDateISO" : eg. "2023-11-03T21:00:00+05:30"
    "customerId": 62090013,
    "requestId": 2132,
    "triggeredBy": {
        "ownerType": "Loyalty",
        "referenceId": "123694"
    }
}

Response 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, in epoch milliseconds timestamp format.
expiresOnISO	String	The time indicating when the badge expires in the ISO 8601 standard format eg. "2025-09-10T15:00:00+05:30.
requestId	String	A unique identifier to identify the request.
issuedId	String	A Unique identifier representing the specific issuance instance of the badge.
errors	Array	Array to list any errors.
warnings	Array	Array to list any warnings.

{
    "data": {
        "badgeMetaId": "66da90348bdb494a4f06576f",
        "customerId": 11231,
        "earnedBadgeId": "66da90618bdb494a4f065774",
        "expiresOn": 1726809439.822462000,
        "expiresOnISO": 2024-09-20T10:47:19+05:30,
        "requestId": "NaYAzxXfJhHvRm4l7KiD",
        "issuedId": "66da903a8bdb494a4f065770"
    },
    "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

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!