Enrol/Re-enrol a customer to a milestone/streak

post

https://{host}/v3/targetGroups/{targetGroupId}/targets/{targetId}/enroll

This API helps in enrolling users into a milestone/streak

Body Params

customerId

string

required

Unique ID of the customer.

periodName

string

required

Name of the period/cycle into which the user has to be enrolled/re-enrolled in the case of Milestones. Also, period names can be found from the UI of the milestone. In the case of Streaks, this field itself is not needed.

initialBalance

int32

The initial balance amount assigned to the customer. This could be 0 or any other number, and when a user enrols with initial balance, the amount of targets needs to be achieved will be decreased by same value. If this given as NULL in the case or re-enrol, then the user's target value will start from the same value at which the un-enrol happened before. Initial balance field won't work for streaks.

resetStreakStatus

boolean

Defaults to false

This field is only for streaks. If this is false, user will continue from the streak value that is present before the un-enrol from the streak. If this is marked as true during re-enrol, then the streak value of the user will be reset & it's like starting fresh.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400