Import earned (issued) badges of customer

This API allows you to issue badges for customers in bulk.

๐Ÿ‘

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 .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/v1/badges/import/customerBadges
HTTP methodPUT
Rate limitNA
Batch supportNA

Request body parameter

ParameterData TypeDescription
badgeMetaId*StringUnique identifier ("id") generated during the creation of the badge.
customerId*IntegerUnique identifier for the customer.
earnEventDate*DateTimestamp of when the earning event occurred. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
earnExpiresOn*DateTimestamp of when the earned item expires. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
[
   {
       "badgeMetaId": "654e08f2041fd452b3ef5b2e",
       "customerId": 382442802,
       "earnEventDate": 1674292011,
       "earnExpiresOn": 1705828011
   },
   {
       "badgeMetaId": "654e08f2041fd452b3ef5b2e",
       "customerId": 382442802,
       "earnEventDate": 1674292011,
       "earnExpiresOn": 1705828011
   }
]

Response parameter

ParameterData TypeDescription
badgeMetaIdStringUnique identifier for the badge metadata
customerIdIntegerUnique identifier for the customer
earnedBadgeIdStringUnique identifier for the earned badge
expiresOnFloat/DoubleTimestamp of when the badge or item expires
requestIdStringUnique identifier for the request
errorsNull/ObjectContainer for any errors (null if no errors)
warningsNull/ObjectContainer for any warnings (null if no warnings)
[
   {
       "data": {
           "badgeMetaId": "654e08f2041fd452b3ef5b2e",
           "customerId": 382442802,
           "earnedBadgeId": "6576f7d291e0b01c659ad606",
           "expiresOn": 1705828011.000000000,
           "requestId": "f93f710f169c8390c41ae095986c5a50_1"
       },
       "errors": null,
       "warnings": null
   },
   {
       "data": {
           "badgeMetaId": "654e08f2041fd452b3ef5b2e",
           "customerId": 382442802,
           "earnedBadgeId": "6576f7d291e0b01c659ad609",
           "expiresOn": 1705828011.000000000,
           "requestId": "f93f710f169c8390c41ae095986c5a50_2"
       },
       "errors": null,
       "warnings": null
   }
]


Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!