This API endpoint enables initiating a Goodwill points Workflow, enabling the allocation of goodwill points to a customer.
👍
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 .
Maker request access (CanMakeRequest). Contact the access team for access.
Resource information
URI
/api_gateway/v2/request-workflow/GOODWILL-POINTS`
HTTP Method
POST
Pagination
No
Batch support
No
Rate limit information
None
Header information
X-CAP-API-AUTH-ORG-ID
Organization ID
X-CAP-UI-AUTH-TOKEN
A JSON Web Token (JWT) is used for intouch user authentication. CanMakeRequest access is required to generate this token.
Request body parameters
Parameter (Parameters marked * are mandatory)
Type
Description
entityInfo*
Object
Information about the entity (till, store, zone, concept)
- tillId*
String
The unique identifier for the till associated with the transaction.
- storeId*
String
The unique identifier for the store where the transaction occurs.
- zoneId*
String
The unique identifier for the zone or area the store is associated with.
- conceptId*
String
The unique identifier for the concept or branding associated with the store.
payload
Object
The Intouch payload for the Goodwill points Workflow is a structured set of data that facilitates the allocation of goodwill points within the Intouch system. This payload contains specific information required to execute this operation.
- IntouchAPITask-Payload
Object
Information about the Intouch API task
- hostname*
String
Hostname for the API endpoint. Example - <https://eucrm-new.cc.capillarytech.com>
- path*
String
/internal/goodwill/. This path denotes the endpoint within the API that manages the allocation of goodwill points. It defines the action that needs to be performed, which in this case, is the allocation of goodwill points
- method*
String
POST. The HTTP method used for the request
\pathParams
Object
This field is reserved for any dynamic parameters that may be included in the API endpoint URL. Note: In this workflow, pathParams may not be utilized, as the necessary information is typically provided in the request body.
\queryParams*
Object
Additional parameters that can be appended to the API request URL for further customization. *Note:** In this workflow, query parameters may not be utilized, as the necessary information is typically provided in the request body.
\body*
Object
The body section contains the essential data for the goodwill points operation
referenceId*
String
Unique reference ID for the request
reason*:
String
This field specifies the reason for the goodwill points allocation. It might include information like why the goodwill points allocation is being done.
baseType*:
String
This indicates the type of entity that we are allocating. POINTS, in this case.
programId*
Number
Specifies the loyalty program ID for which goodwill points allocation is taking place.
awardingTillId*
Number
Specifies the till ID from which goodwill points allocation is taking place.
earningEntityType*
String
Specifies the entity Type for which goodwill point allocation is taking place, eg “CUSTOMER“.
earningEntityId*
Number
Specifies the ID of the user for which goodwill point allocation is taking place
points*
Number
Specifies the amount of points to be allocated
source*
String
Specifies the source of goodwill point allocation eg “API”.
\headers*
Object
Headers provide additional context and information about the request.
- Authorization
String
Contains the authentication credentials needed to access the Intouch API.
- content-type
String
The content type of the request (application/JSON in this case). This field specifies that the payload is in JSON format, ensuring that the data is properly interpreted by the API.
