Perform an Activity API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint will share the details of the activity performed in the UI with Trueloyal. And based upon the configuration done in admin console, the points will be awarded to the members. Every activity has its unique attributes which has to be passed in the transaction attributes with the activity ID. The activities with their attributes are detailed in the body params. For more details on this, refer to API Authentication.

Body Params
string
required

Enter activity_id.

json

You have to pass different transaction_attributes for different activities:

Share on Facebook/ Twitter/ Pinterest

Activity ID: share_on_facebook/ share_on_twitter/ share_on_pinterest

Transaction attributes:

{

"track_code":""

}

Note: You can obtain the track code of sharing activities using Get Activity Track Codes API.

Submit a receipt activity

Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

Activity ID: submit_a_receipt

Transaction attributes:

{

"receipt_files": [""]

}

Code submission activity

Activity ID: code_submission

Transaction attributes:

{

"code": ""

}

Follow on instagram

Activity ID: follow_on_instagram

Transaction attributes:

{}


Upload a photo activity

Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

Activity ID: upload_photo

Transaction attributes:

{

"image_file": [""]

}

Refer to a friend

Activity ID: referral

Transaction attributes:

{

"share_network": "mail",

"to_addresses":["[email protected]","[email protected]"]

}

In share_network, pass the source of referral- mail, twitter or facebook. And in to_addresses, you have to pass email address of the referral. 

It's important to note that passing email addresses is mandatory only when "mail" is selected as the "share_network." For other share networks like "twitter" or "facebook," email addresses are not required.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json