Create streaks

post

https://{host}/v3/targetGroups

Body Params

active

boolean

Indicate if the target is active.

description

string

Brief description of the target. The character limit for the description is 255 characters and special characters are supported.

name

string

required

Name for the target. The name can be up to 200 characters long, supports special characters, and is case-insensitive.

preferredTillId

int32

Identifier for the preferred or primary POS till for the target.

trackingType

string

enum

required

Type of tracking the milestone is created for.

Allowed:

targetEvaluationType

string

enum

required

Defines the type of time frame used for evaluating the target.

Allowed:

totalPeriods

int32

required

Total number of period cycles for the target group.

frequencyType

string

enum

required

Frequency of each cycle in which the user has to achieve the target value

Allowed:

frequency

int32

required

Number of units corresponding to the selected frequencyType For example: If frequencyType is DAILY and frequency is 10, the cycle spans ten days.

recurringCycles

int32

required

Total number of cycles defined for the target group. Once a cycle is complete, the target is reset for the new cycle. A maximum of 100 cycles can be defined for a target group.

endDate

string

required

End date and time of the period in ISO 8601 YYYY-MM-DDTHH:mm:ss.SSS format. Example: 2024-10-24T23:59:00.000.

periodStatus

string

enum

Indicate if the cycle of the Milestone is running or upcoming.

Allowed:

refCode

string

required

A reference code for the period.

startDate

string

required

Start date and time of the period in ISO 8601 YYYY-MM-DDTHH:mm:ss.SSS format. Example: 2024-10-24T00:00:00.000

expression

boolean

Indicate if the target has an expression for evaluation.

expressionJson

string

A JSON expression that specifies the conditions required to achieve the target. The expression is generated in the backend.

targetEntity

string

enum

required

Defaults to ALTERNATE_CURRENCIES

KPI on which the target is tracked.

Allowed:

enrolmentMethod

string

enum

Method of enrolment for the target.

Allowed:

targetType

string

enum

required

Type of target

Allowed:

defaultValue

float

Default value for the target.

alternateCurrencyIdentifier

string

required

Unique identifier of the alternate currency that is generated when creating an alternate currency.

programId

int32

required

Unique ID of the loyalty program that includes the alternate currency.

Responses

201Created

400400