Custom Task API

The custom task functionality available for custom-built sites allows you to create tasks that cater to specific processes and requirements. Once a custom task is created and added to the loyalty program, the Thrive system must be notified each time it is completed. Push the details of the completed task to Zoho Thrive using the API instructions provided below.

 HTTP Request 

  1. Generate an OAuth token to send as a part of the request, ensuring the details of the completed task are pushed safely.
     

OAuthScope: Thrive.Referral.CREATE

  1. Create an HTTP request with the following:

Request Method: POST  
Request URL: {domain URL}/thrive-publicapi/v1/${brand-code}/activities

Parameter Name

Parameter Key

Description


Unique ID *


unique_identifier


Unique identifier assigned by you to the task while creating it.

Email *

email


Email address of the customer who performed the task


Customer ID *


zt_customer_id


 Unique identifier assigned to a customer within your system to identify and distinguish them from others.


Digest *


thrive_digest


Generated HMAC 

* - mandatory

Note: The request body must contain the parameter key related to the parameter used, and not its name.

Request Response

  • 200 - Success

  • 404 - If any mandatory (*) parameters are missing

Sample Post Body

Copiedcurl --request POST \
--url https://thrive.zoho.com/thrive-publicapi/v1/dc784dccb06e501a6853189cf941c4673ba5cd999da4dafb90c3f5d7/activities \
--header "Authorization: Bearer 1000.bde43b528b304341562a831b87d6889c.d9495c501be1f2c4a455f18ffe4b5b43" \
--header "Content-Type:application/json" \
--data '
{
"unique_identifier":"signup_for_webinar",
"zt_customer_id":"dir_1651130310493",
"email":"peter.prescot@zylker.com",
"thrive_digest":"fa04d2467feb9bbf9be79fece58d6ebc5ab0183939008f85d722a7334be3c3e"
}'

  • The URL in line 2 is the same as the Request URL. Do not forget to replace the URL placeholder with the Domain URL appropriate to your domain.

  • The access token generated using OAuth is sent as the Authorization in line 3.

  • Each parameter key is followed by their respective variables within the quotation marks.