Sign in

Achieve Social Campaign

Mark a social campaign as achieved for a customer and grant the configured reward from your backend. This is the server-to-server equivalent of the in-widget social action for Social Activities campaigns.

post/api/v4.0/integrations/customers/social-challenges

Request body

customerIdstring required

The customer's unique ID in your system. The customer must already exist in Gameball.

challengeIdinteger required

The ID of the Social Activities campaign to award.

emailstring

Customer's email address. Helps identify the customer when channel merging is enabled.

mobilestring

Customer's mobile number. Helps identify the customer when channel merging is enabled.

Example request

{
  "customerId": "customer_123",
  "challengeId": 11664,
  "email": "john.doe@example.com",
  "mobile": "+1234567890"
}

Response

Social challenge achievement accepted for processing

customerIdstring

The customer ID from the request.

challengeIdinteger

The social campaign ID from the request.

gameballStatusstring

Present when the Gameball program is disabled. Omitted while Gameball is enabled.

messagestring

Informational message when the Gameball program is disabled.

learnMorestring

Link to learn more when the Gameball program is disabled.

Example response

{
  "customerId": "customer_123",
  "challengeId": 11664
}

Changes

Changed in 2 of the 38 revisions of this API.11