Developer Documentation

Update Reward Expiry Reminder

put https://{host}/api_gateway/rewards/core/v1/reward/expiryReminder/

This API is used to update the Reward expiry reminder to remind the user that their rewards are expiring.

👍

Note

  • For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/rewards/core/v1/reward/expiryReminder/{rewardExpiryReminderid}
HTTP MethodPUT
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/reward/expiryReminder/1

Request path parameters

Parameter NameData TypeDescription
rewardExpiryReminderid*IntegerUnique identifier of Reward Expiry Reminder

Request body parameters

Parameter NameData TypeDescription
isActiveBooleanThis indicates whether the reward expiry reminder is active or not.
duration*IntegerThe duration specifies how many days in advance the reward expiry reminder will be sent before the reward expires. This does not have any default value set and is mandatory.
timingtimestampThis defines the specific time when the reminder will be sent. The time should be provided in 24-hour format (HH:MM) and represents the the org's cluster (server) time. If no time is specified, the reminder will automatically be set for 16:00 server time for the org's cluster.
{
    "isActive":true,
    "duration": 15,
    "timing": "12:00"
}

Response parameters

Parameter NameDescription
successIndicates if the request was successful.
codeResponse status code.
messageMessage describing the status of the response.
idUnique identifier for the reward expiry reminder.
orgIdIdentifier for the organization associated with the reminder.
durationDuration before the expiry to send a reminder.
durationTypeType of duration.
cronTaskIdThis is the unique database identifier for each cron setup, with each cron associated with specific timing, modules, and other relevant parameters.
timingTime at which the reminder will be triggered (in HH:MM format).
isActiveIndicates whether the reminder is currently active.
createdOnTimestamp of when the reminder was created in epoch timestamp
lastUpdatedOnTimestamp of the last update in epoch timestamp.
createdByIdentifier of the user who created the reminder.
lastUpdatedByIdentifier of the user who last updated the reminder.
{
    "status": {
        "success": true,
        "code": 12040,
        "message": "Reward expiry reminder updated"
    },
    "rewardExpiryReminder": {
        "id": 5,
        "orgId": 100458,
        "duration": 15,
        "durationType": "DAYS",
        "cronTaskId": 590567,
        "timing": "12:00",
        "isActive": true,
        "createdOn": 1727681940000,
        "lastUpdatedOn": 1727681940000,
        "createdBy": 75130850,
        "lastUpdatedBy": 75130850
    }
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Duration is mandatory"
    }
}

{
    "status": {
        "success": false,
        "code": 400,
        "message": "Reward expiry reminder with id 34 does not exist"
    }
}

API-specific error codes

Error codeDescription
400Duration is mandatory
400Invalid Reward Expiry Reminder ID
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!