AdjustmentInput3

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

Kind	Type
Used in	AdjustCustomerState3

Properties

• description string optional

  Customer-visible description of the change.

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

• private_note string optional

  Extra information about the change for the staff eyes only.

• action AdjustmentAction1 required

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

• points integer required for relevant actions

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

• change_id bubbleflake required for relevant actions

  A reference to the change to act upon.

• mark CustomerMark1 required for relevant actions

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

• subject_id bubbleflake one of subject fields is required for relevant actions

  Specifies an object to act upon by its Bubblehouse ID.

• subject_slug string one 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.