Add Loyalty Points

Add points to customer profile

PUT/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Add Loyalty Points action (under management).
Fill in the fields below, then reference the result from later steps as {{addLoyaltyPoints.response.data}}.

Request

Path parameters

loyaltyProgramIdstringrequired

The identifier for the loyalty program.

integrationIdstringrequired

The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

Request body

Enter the body as JSON in the step's Body field.

pointsnumberrequired

Amount of loyalty points.

namestring

Name / reason for the point addition.

validityDurationstring

The time format is either: - `unlimited` or, - an **integer** followed by one letter indicating the time unit. Examples: `unlimited`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted.

validUntilstring (date-time)

Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted.

pendingDurationstring

The amount of time before the points are considered valid. The time format is either: - `immediate` or, - `on_action` or, - an **integer** followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`, `on_action`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.

pendingUntilstring (date-time)

Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted.

subledgerIdstring

ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically.

applicationIdinteger (int64)

ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL.

json

{
  "points": 300,
  "name": "Compensation",
  "validityDuration": "5D",
  "validUntil": {},
  "pendingDuration": "12h",
  "pendingUntil": {},
  "subledgerId": "sub-123",
  "applicationId": 322
}

Response

Returns 204 with a any. Read it in later steps with {{addLoyaltyPoints.response.data.<field>}}.

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?