Modify targets

put deprecated

https://{host}/v3/targetGroups/{groupId}/targets/{targetId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

❗️
This API is being phased out and will no longer be available for creating new milestones.
To create a new milestone, use the Create a Loyalty Promotion API

This API is used to modify targets in a target group. Meaning, "target group id", "target id" is needed and that is a mandatory parameter while calling this API.

Click on 200 symbol to see sample 200 response.

Click on request body example to see the example for the same.

Both will be available on the right side of the screen.

Path Params

groupId

int32

required

Group ID for which target needs to be added.

targetId

int64

required

Id of the target that need to be modified

Body Params

active

boolean

Current status of the target.

description

string

Short description of the target.

emfRuleSetId

int32

emfUnrolledRulesetId

int32

enrolmentMethod

string

enum

How to enroll customers and add target values. Values: TRANSACTION (enroll loyalty customers who transacts during the target period), IMPORT (to import a list of customers with custom target value).

Allowed:

expression

string

expression of the rule

expressionJson

string

Condition (rule expression) to be evaluated based for the chosen targetEntity.

filters

object

Restrict the target to specific stores.

name

string

required

Name of the target. Modifying the name is not recommended as it may lead to issues in loyalty promotions.

targetEntity

string

enum

Entity to define target condition. Values: TRANSACTION, LINEITEM, POINTS. For example, pass LINEITEM to define condition on the transaction line item.

Allowed:

targetGroupId

int32

Unique ID of the target group associated with the target.

targetType

string

enum

required

Transaction parameter to consider for the target. Values: QUANTITY, SALES, COUNT, VISIT.

Allowed:

Responses

This API is being phased out and will no longer be available for creating new milestones.

200200

400400