Easily test these API methods dynamically by using our Postman Collection. Just change the Token in the Authorizations tab, and the campaign_id variable to the campaign you're working on.
Campaigns
Get Campaign
GEThttps://api.loyaltysurf.io/v1/campaign/:id
Retrieves a campaign for the given ID.
Path Parameters
Name
Type
Description
id*
string
The ID of the campaign to retrieve
{
"id": "abc123",
"name": "Pied Piper Advocate Program",
"loyaltyActionCount": 121,
"participantCount": 199,
"winnerCount": 1,
"status": "IN_PROGRESS",
"rewards": [
{
"id": "xyz789",
"description": "Make a LinkedIn post mentioning Pied Piper",
"subdescription": "Post must be less than 1 week old from date of submission",
"instructions": "<div><p><strong>Helpful tips:</strong></p><ul><li>Talk about how you used to do things before using Pied Piper</li><li>Mention specific ROIs (e.g, time saved, revenue generated)</li></ul></div>",
"cta": "Get $25",
"submissionType": "URL",
"submissionExampleUrl": "https://linkedin.com/posts/sarah_s-my-review-of-pied-piper-8195769799870726145-Sr9b",
"submissionFormUrl": "https://linkedin.com/shareArticle",
"submissionFormFields": [
{
"key": "linkedinPostUrl",
"label": "Your LinkedIn Post URL",
"placeholder": "Enter your LinkedIn Post URL here",
"type": "text",
"isRequired": true,
"isVisible": true
}
],
"submissionFormButtonText": "Submit",
"submissionFormMessages": {
"required": "is required",
"reCaptchaRequired": "You must pass the reCAPTCHA verification.",
"success": "Thanks! We have received your response.",
"error": "There was an error. Please try submitting again.",
"alreadySubmitted": "You already submitted this form."
},
"isUnlimited": false,
"limit": 1,
"conversionsRequired": 1,
"imageUrl": "http://res.cloudinary.com/loyaltysurf/image/upload/v1552764861/development/hxdcjrayfhksvxu5u6oz.png"
}
]
}
Get Campaigns
GEThttps://api.loyaltysurf.io/v1/campaigns
Retrieves a list of your campaigns. Campaigns that have been deleted will not be returned in this response.
{
"campaigns": [
{
"id": "abc123",
"name": "Pied Piper Advocate Program",
"loyaltyActionCount": 20500,
"participantCount": 40000,
"winnerCount": 1500,
"status": "IN_PROGRESS",
"rewards": [
{
"id": "xyz789",
"description": "Make a LinkedIn post mentioning Pied Piper",
"subdescription": "Post must be less than 1 week old from date of submission",
"instructions": "<div><p><strong>Helpful tips:</strong></p><ul><li>Talk about how you used to do things before using Pied Piper</li><li>Mention specific ROIs (e.g, time saved, revenue generated)</li></ul></div>",
"cta": "Get $25",
"submissionType": "URL",
"submissionExampleUrl": "https://linkedin.com/posts/sarah_s-my-review-of-pied-piper-8195769799870726145-Sr9b",
"submissionFormUrl": "https://linkedin.com/shareArticle",
"submissionFormFields": [
{
"key": "linkedinPostUrl",
"label": "Your LinkedIn Post URL",
"placeholder": "Enter your LinkedIn Post URL here",
"type": "text",
"isRequired": true,
"isVisible": true
}
],
"submissionFormButtonText": "Submit",
"submissionFormMessages": {
"required": "is required",
"reCaptchaRequired": "You must pass the reCAPTCHA verification.",
"success": "Thanks! We have received your response.",
"error": "There was an error. Please try submitting again.",
"alreadySubmitted": "You already submitted this form."
},
"isUnlimited": false,
"limit": 1,
"conversionsRequired": 1,
"imageUrl": "http://res.cloudinary.com/loyaltysurf/image/upload/v1552764861/development/hxdcjrayfhksvxu5u6oz.png"
}
]
},
{
"id": "ljtqn5",
"name": "Pied Piper Advocate Program #2",
"loyaltyActionCount": 30500,
"participantCount": 60000,
"winnerCount": 750,
"status": "IN_PROGRESS",
"rewards": [
{
"id": "qiar1r",
"description": "Make an X (Twitter) post about Pied Piper",
"subdescription": "Post must be less than 1 week old from date of submission",
"instructions": "<div><p><strong>Helpful tips:</strong></p><ul><li>Talk about how you used to do things before using Pied Piper</li><li>Mention specific ROIs (e.g, time saved, revenue generated)</li></ul></div>",
"cta": "Get $15",
"submissionType": "URL",
"submissionExampleUrl": "https://x.com/Sarah_S/status/2307836134014308344",
"submissionFormUrl": "https://x.com/compose/post",
"submissionFormFields": [
{
key: "twitterPostUrl",
label: "Your Twitter Post URL",
placeholder: "Enter your Twitter Post URL here",
isRequired: true,
isVisible: true
}
],
"submissionFormButtonText": "Submit",
"submissionFormMessages": {
"required": "is required",
"reCaptchaRequired": "You must pass the reCAPTCHA verification.",
"success": "Thanks! We have received your response.",
"error": "There was an error. Please try submitting again.",
"alreadySubmitted": "You already submitted this form."
},
"isUnlimited": false,
"limit": 1,
"conversionsRequired": 1,
"imageUrl": "http://res.cloudinary.com/loyaltysurf/image/upload/v1552764861/development/hxdcjrayfhksvxu5u6oz.png"
}
]
}
]
}
Triggers a loyalty action for a person, awarding loyalty action credit to them and adds them to the campaign as a participant if they do not already exist.
If the required number of loyalty actions of the campaign reward is reached, then the reward will be unlocked.
Path Parameters
Name
Type
Description
id*
string
The ID of the campaign
Request Body
Name
Type
Description
participantEmail*
string
The email of the person that performed the loyalty action. If the person already exists as a participant, then their loyalty action count will be incremented.
rewardId*
string
The campaign reward ID that the participant will earn upon completing the required number of loyalty actions.
addParticipantIfNoneExists
boolean
Adds the person to the campaign as a participant if they do not already exist. Defaults to true.
metadata
object
A shallow Object containing custom key/values to include with the participant data.
The ID of the participant to start the next result set with. This can be used to skip through the list or to page the list results. Each response will provide a nextId value if there are more participants otherwise the nextId value will be null.
limit
integer
The number of participants to return. Must be a value less than or equal to 100 which is currently the maximum we allow with this request.
Retrieves a list of participants in the campaign ordered by loyalty action count in ascending order.
Monthly Loyalty Action Count Leaderboard
You can retrieve the campaign leaderboard ordered by the monthly loyalty action count by providing a query parameter leaderboardType with a value of CURRENT_MONTH. This will retrieve a list of participants ordered by monthly loyalty action.
Monthly loyalty action counts are automatically reset at the end of each month for each participant within your campaign, therefore results of the monthly loyalty action count may vary.
Previous Monthly Loyalty Action Count Leaderboard
Similar to the monthly campaign leaderboard, providing a query parameter of leaderboardType with a value of PREV_MONTH will retrieve a list of participants ordered by the previous monthly loyalty action count.
Participants that did not exist within the campaign during the previous month will not be returned within the previous monthly leaderboard response.
Path Parameters
Name
Type
Description
id*
string
The ID of the campaign
Query Parameters
Name
Type
Description
nextId
string
The ID of the participant to start the next result set with. This can be used to skip through the list or to page the list of results. Each response will provide a nextId value if there are more participants otherwise, nextId will be null.
limit
string
The number of participants to return. Must be a value less than or equal to 100 and greater than 1. 100 is currently the maximum limit per reach request.
leaderboardType
string
Returns the leaderboard for the specified type if provided.
OptionsALL_TIME - Returns the all-time leaderboard, based on all-time loyalty action counts. DefaultCURRENT_MONTH - Returns the current month's leaderboard, based on the current month's loyalty action counts.
PREV_MONTH - Returns the previous month's leaderboard, based on the previous month's loyalty action counts (With this option, participants that did not exist within the campaign during the previous month will not be returned).
Though they are optional, we recommend passing in the fields ipAddress, fingerprint, firstName , and lastName . These fields are used for anti-fraud purposes.
Path Parameters
Name
Type
Description
id*
string
The ID of the campaign to add the new participant to
Request Body
Name
Type
Description
email*
string
The email of the new participant
firstName
string
(Optional, but recommended) The first name of the new participant. If provided, this property will be used for anti-fraud measurements.
lastName
string
(Optional, but recommended) The last name of the new participant. If provided, this property will be used for anti-fraud measurements.
ipAddress
string
(Optional, but recommended) The IP address of the new participant. If provided, this property will be used for anti-fraud measurements.
fingerprint
string
metadata
object
A shallow Object containing custom key/values to include with the participant data.
The following keys are restricted: gdprAgreements
Updates a participant within the campaign using the ID of the participant.
Path Parameters
Name
Type
Description
id*
string
The ID of the campaign
participantId*
string
The ID of the participant
Request Body
Name
Type
Description
email
string
The new email to assign to this participant.
If the given email is already assigned to another participant within the campaign, an error response will be returned.
firstName
string
The first name of the participant.
lastName
string
The last name of the participant
metadata
object
A shallow Object containing custom values to include in the participant data.
If any existing metadata exists for the participant, any new values provided will be appended to the existing metadata, any existing values provided will overwrite and replace the existing metadata.*
To remove any existing metadata set its value to null.
unsubscribed
boolean
The participant's unsubscribed status. If true, they will not receive any campaign emails.
Updates a participant within the campaign using the email of the participant.
Path Parameters
Name
Type
Description
id*
string
The campaign ID
participantEmail*
string
The participant email
Request Body
Name
Type
Description
email
string
The new email to assign to the participant.
If the given email is already assigned to another participant within the campaign, an error response will be returned.
firstName
string
The first name of the participant
lastName
string
The last name of the participant
metadata
object
A shallow Object containing custom values to include in the participant data.
If any existing metadata exists for the participant, any new values provided will be appended to the existing participant metadata, any existing values provided will overwrite and replace the existing metadata.*
To remove existing metadata set its value to null.
unsubscribed
boolean
The participant's unsubscribed status. If true, they will not receive any campaign emails.
Retrieves a list of rewards earned by a participant.
Path Parameters
Name
Type
Description
id*
string
The campaign ID
participantId*
string
The participant's unique ID or email
Query Parameters
Name
Type
Description
nextId
string
The id of the participant reward to start the next result set with. This can be used to skip through the list or to page the list of results. Each response will provide a nextId value if there are more rewards otherwise the nextId will be null.
limit
string
The number of rewards to return. Must be a value less than or equal to 100, which is currently the maximum allowed per request.
Retrieves a list of rewards earned by a participant.
Paging this response
Each response will contain a nextId, that value is the id of the next participant and not the email therefore, you must use this endpoint in conjunction of our Get Participant Rewards by ID endpoint if you wish to page results starting with this endpoint. To page you would provide the nextId as the participantId path parameter within the Get Participant Rewards by ID request.
Path Parameters
Name
Type
Description
id*
string
The id of the campaign.
participantEmail*
string
The participant email
Query Parameters
Name
Type
Description
nextId
string
The id of the participant reward to start the next result set with. This can be used to skip through the list or to page the list of results. Each response will provide a nextId value if there are more rewards otherwise the nextId will be null.
limit
string
The number of rewards to return. Must be a value less than or equal to 100, which is currently the maximum allowed per request.
Fulfilling a reward does not trigger any emails or automations. It helps you stay organized when managing rewards from your LoyaltySurf admin dashboard.
Fulfilling a reward does not trigger any emails or automations. It helps you stay organized when managing rewards from your LoyaltySurf admin dashboard.
Remove a reward that was earned by a participant.
This only applies if your campaign was configured with manual reward approval and if the provided participant reward has not been approved.
Path Parameters
Name
Type
Description
id*
string
The campaign ID
rewardId*
string
The ID of the participant reward to remove
{
"success": true
}
{
"name": "InvalidRewardState",
"code": "INVALID_REWARD_STATE",
"message": "Invalid reward state. This reward has already been approved and cannot be removed.",
"status": 406,
"supportUrl": "https://loyaltysurf.io/settings#contact_support",
"level": "error",
"timestamp": "2019-10-17T16:43:05.902Z"
}
Metadata: Please see our for more information about metadata.
(Optional, but recommended) The browser fingerprint of the new participant. If provided, this property will be used for anti-fraud measurements.
We recommend using a front-end library like to get the fingerprint value. Example value: cfb163bd47ba666c52cb932c521e47f4.
Metadata: Please see our for more information about metadata.
*Please see our for more information about metadata.
*Please see our for more information about metadata.
Approve a reward that was earned by a participant.
You should only use this endpoint if your reward automation level is set to Manually approve rewards (learn more ). This means will be generated with status: "PENDING", approved: false, and isFulfilled: false.
Calling this endpoint to approve a reward will cause New Participant Reward emails to be sent out and automations/integrations to be triggered. If you are using Webhooks to automate rewards, a new event will be emitted with data.reward.approved as false.
Fulfill a reward that was earned by a participant (this can only be done if the reward is already approved). When you call this endpoint, the should have the following key-values: status: "PENDING", approved: true, and isFulfilled: false.
