Opt In to Challenge

Allows loyalty users to explicitly opt into challenge campaigns. This functionality is disabled by default. Contact your Punchh representative to update this configuration setting.

Headers

Authorization
Type: string
required

Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE.
Accept
Type: string
required

Advertises which content types the client is able to understand
Accept-Language
Type: string

Preferred language
Content-Type
Type: string
required

Set this header to application/json.
x-pch-digest
Type: string
required

The signature for the API call
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.

Body

application/json

client
Type: string
required

OAuth client ID provided by the business
id
Type: string
required

ID of the challenge to opt in

Responses

application/json
application/json
application/json
application/json

put/api2/mobile/challenge_opt_in

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/challenge_opt_in \
  --request PUT \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --header 'Accept: application/json' \
  --header 'Accept-Language: en' \
  --header 'Content-Type: application/json' \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --header 'punchh-app-device-id: APP_DEVICE_ID_GOES_HERE' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "id": "63724"
}'

{
  "message": "You have been successfully enrolled in the challenge campaign."
}

OK: For a valid user and campaign ID, the API returns 200 OK with "status": "success".