Home API Scheduler API

Scheduler API

Last updated on Dec 19, 2024

Schedulers are used to automate updates for goals or offers, such as changing payout values.

Retrieve Scheduler Listings

  • Endpoint: GET /manager/api/customer/v1/offer_goal_schedulers

  • Headers: X-AUTH-TOKEN

  • Returns a list of schedulers, including the offer goal, status, and scheduled update time.

Create a New Scheduler

  • Endpoint: POST /manager/api/customer/v1/offer_goal_schedulers

  • Headers: X-AUTH-TOKEN

  • Request Body:

    
    {
    
      "offerGoal": "/manager/api/offer_goals/39",
    
      "value": 12,
    
      "updateAtDatetime": "2024-01-01T23:59:59+0200"
    
    }
    
    

Update a Scheduler

  • Endpoint: PATCH /manager/api/customer/v1/offer_goal_schedulers/{id}

  • Headers:

    • Content-Type: application/merge-patch+json

    • X-AUTH-TOKEN

  • Request Body:

    
    {
    
      "status": 1,
    
      "value": 2147483647,
    
      "updateAtDatetime": "2024-06-14T08:04:12.890Z"
    
    }
    
    

Delete a Scheduler

  • Endpoint: DELETE /manager/api/customer/v1/offer_goal_schedulers/{id}