post-api2-mobile-users-request_reactivation

Reactivate User Profile

​

Enables users to reactivate their deactivated profiles directly from the mobile app if 1) guests are allowed to raise reactivation requests via mobile app and iFrame and 2) the admin indicates that a user profile is eligible for future activation when deactivating the user profile in the Punchh platform.

The API returns a 200 response and sends a reactivation email with the subject line "Reactivate account instructions" to the user. The email message will contain instructions on how to proceed with the reactivation process and a link to complete the reactivation request. When the user clicks the link, a message is sent to the Punchh server for account reactivation. A message is displayed to the user stating "Your reactivation request has been received successfully. Please check the status in the next 24-48 hours."

If the phone number of the user is used for reactivation on the mobile app (applicable only when the phone number sign-up feature is enabled for the business), the user is prompted to enter the OTP (One-Time Password) sent to the user's phone number. After the user submits the OTP, the request for reactivating the user account is sent to the Punchh server. The sign-up feature can be enabled in the Punchh platform for new businesses.

If email alerts are enabled for admins for all reactivation requests and if at least one admin is selected, the admin will receive email alerts for each reactivation request raised by users.

The Guests > Reactivation Requested tab in the Punchh platform lists all pending requests for account reactivation. The business can manually approve all reactivation requests made through the mobile app via the Punchh platform or opt for automatic approval.

Note: Contact your Punchh representative to update these Punchh platform configurations.

Headers
  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • User-Agent
    Type: string
    required

    Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

  • punchh-app-device-id
    Type: string
    required

    The app device ID helps Punchh identify each device so that certain rewards can be awarded individually to each device instead of per user. For example, the sign-up reward is given to each device ID to prevent fraudulent sign-ups so that a user cannot do repeated sign-ups from a single device to get rewards. It should not change even if the user resets a device. See the sample code to generate the punchh-app-device-id header.

  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Accept-Language
    Type: string

    Preferred language

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

Body
application/json
  • client
    Type: string
    required

    OAuth client ID provided by the business

  • email
    Type: string
    required

    Email address of the user that was used for creating the loyalty account

  • phone
    Type: string

    Phone number of the user that was used for creating the loyalty account (applicable only when the phone number sign-up feature is enabled for the business)

Responses
  • 200

    200 OK. On submitting the request, the API returns this message in the response: "Please check your email for instructions on reactivating your account".

  • 422
    Type: object
    • error
      Type: string
post/api2/mobile/users/request_reactivation
No Body

200 OK. On submitting the request, the API returns this message in the response: "Please check your email for instructions on reactivating your account".