Request Goodwill points (Group)

Use this API to allocate goodwill points to a user group.

This API will generate a request to the admin for the brand, to approve the request. Use the approve request API, to approve the request. Refer the API here

Request Body Parameters (for group goodwill requests)

ParameterDatatypeDescription
typeenumType of request. Value: GOODWILL.
base_typeenumSub-type of the request. Value: POINTS.
earning_entity_typeenumUSERGROUP2
identifier_valuestringGroup id
{
  "type": "GOODWILL",
  "baseType": "POINTS",
  "goodwillRequest": {
    "comments": "Customer is Good, award him 100 pts.",
    "points": 100,
    "reason": "POINTS_ISSUE"
  },
  "earningEntityType": "USERGROUP2",
  "userGroup2IdentificationInfo": {
    "identifierType": "id",
    "identifierValue": 3832764,
    "source": "INSTORE",
    "accountId": "565118794"
  },
  "comments": "request add via automation",
  "programId": 973
}

Response Parameters

ParameterDatatypeDescription
idlongUnique ID generated for the goodwill request.
warningsstringWarnings if any.
{
    "createdId": 13044649,
    "warnings": []
}

API specific Error codes

Error CodeDescriptionReason
400Input is invalid, Please check request parameters or input xml/json, No identifier provided to get loyalty users.Input invalid in request parameters
93026Invalid Group Details ProvidedGroup id/details invalid or unsupported
1101Invalid programId passedProgram Id invalid or unsupported
9006Request Type is invalidInvalid/ unsupported request type
9008Request Base Type is invalidInvalid/unsupported basetype
Language
URL
Click Try It! to start a request and see the response here!