Joining the loyalty program

Please use the Connections endpoint to faciliate a customer joining the loyalty program. You would change the Connection status to Active.

Caveats

1. You cannot create new Connections via the Connection endpoint. If a Connection does not already exist, the join attempt will fail.

2. status only accepts ACTIVE or INACTIVE.

3. Scope rules apply. With USER_CUSTOMER_INFO, a user can only update their own Connection. With ADMIN_CUSTOMER_INFO, staff can update Connections for their business.

Validation errors (customer-safe copy)

Below are the join-related validation errors that may be returned when setting status=ACTIVE, plus recommended customer-safe messages.

• pv_connection_membership_not_active

  When: The business requires an active membership and the customer’s membership is not active. Customer-safe: “Your membership is not active. Please contact the business for help.”

• pv_agreement_required When: The business requires agreement terms and the customer has not agreed. They will need to review accept the business' terms on the Perkville site before being able to join. Customer-safe: “Please review and accept the required terms to join at {business.perkville_url}"