Loyalty Admin API

AdjustmentInput3

Describes an admin adjustment to a customer's loyalty state.

Properties

  • descriptionstringoptional

    Customer-visible description of the change.

    A default description is supplied if you don't specify one.

  • private_notestringoptional

    Extra information about the change for the staff eyes only.

  • actionAdjustmentAction1required

    The adjustment to perform. This determines what other fields can/must be specified.

  • pointsintegerrequired for relevant actions

    The number of points to add or take away, a positive integer or zero.

  • change_idbubbleflakerequired for relevant actions

    A reference to the change to act upon.

  • markCustomerMark1required for relevant actions

    A mark to add or remove. Note that unlike with tags, specifying an unknown mark results in a failure.

  • subject_idbubbleflakeone of subject fields is required for relevant actions

    Specifies an object to act upon by its Bubblehouse ID.

  • subject_slugstringone of subject fields is required for relevant actions

    Specifies 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.

Previous
MergeCustomers1