Description

Creates a new prospect for a brand.

Only configured optional fields will be accepted.

This feature can only be activated and configured by a SimpleLoyalty admin. Contact us here to enable it.

Parameters

Parameter Type Value Required
operation_name String resendSmsPromotionCode true
variables JSON $JSON_OBJECT true

$JSON_OBJECT Structure

Key Type Value Required
brandId String $SHARED_BRAND_ID true
phoneNumber String $PHONE_NUMBER false
extension String $EXTENSION false
source String $SOURCE false
name String $NAME false
email String $EMAIL false
birthdate String $BIRTHDATE false
shippingCountry String $SHIPPING_COUNTY false

Example

Request

curl \
-X POST \
-H "Content-Type: application/json" \
-H "Token: $TOKEN" \
-d '{
    "operation_name": "addProspect",
    "variables": {
        "brandId": $SHARED_BRAND_ID,
        "phoneNumber": "60123456789",
        "extension": "MY",
        "source": "newsletter",
        "name": "yourName",
        "email": "youremail@email.com",
        "shippingCountry": "MY"
    }
}' \
https://simpleloyalty.com/third_party

Response

{
  "data": {
    "thirdPartyAddProspect": {
      "result": $SUCCESS_MESSAGE,
      "errors": [
        {message: $ERROR_MESSAGE}
      ]
    }
  },
  "errors": []
}