Loyalty Admin API
AdjustmentInput3
Describes an admin adjustment to a customer's loyalty state.
Properties
description
stringoptionalCustomer-visible description of the change.
A default description is supplied if you don't specify one.
private_note
stringoptionalExtra information about the change for the staff eyes only.
The adjustment to perform. This determines what other fields can/must be specified.
points
integerrequired for relevant actionsThe number of points to add or take away, a positive integer or zero.
A reference to the change to act upon.
A mark to add or remove. Note that unlike with tags, specifying an unknown mark results in a failure.
Specifies an object to act upon by its Bubblehouse ID.
subject_slug
stringone of subject fields is required for relevant actionsSpecifies an object to act upon by its string slug.
A slug is a URL-friendly string assigned to an object at creation. This is a convenient way to identify loyalty objects in your code.