Start a draft preview

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/balance-adjustments/previews/{jobId}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60",
    "kind": "mass_credit.preview",
    "type": "preview",
    "state": "running",
    "parentJobId": "<string>",
    "createdBy": "ops@yourfirm.com",
    "createdAt": "<string>",
    "startedAt": "<string>",
    "finishedAt": "<string>",
    "heartbeatAt": "<string>",
    "progress": {
      "total": 120000,
      "processed": 48200,
      "succeeded": 9100,
      "failed": 0,
      "skipped": 39100,
      "planning": false,
      "percent": 40.2
    },
    "summary": {
      "credits": 9100,
      "creditAmount": 1830220.5,
      "lossAmount": 1902118.25,
      "capped": 120,
      "warnings": 14,
      "skip_ACCOUNT_CLOSED": 30000,
      "skip_NO_FILLS": 9100
    },
    "lastError": "<string>",
    "rules": {
      "windowStart": "2026-10-21T13:30:00Z",
      "windowEnd": "2026-10-21T14:15:00Z",
      "lossBasis": "net",
      "includeFees": true,
      "maxCreditPerAccount": null,
      "minCreditPerAccount": null,
      "countTowardDailyPnl": false,
      "moveHighWaterMark": false,
      "requireFlat": false,
      "skipAlreadyCredited": true
    },
    "selection": {
      "mode": "all",
      "filters": {
        "planIds": [
          "<string>"
        ],
        "statuses": [
          "in_progress"
        ],
        "types": [
          "evaluation"
        ],
        "createdFrom": "2023-11-07T05:31:56Z",
        "createdTo": "2023-11-07T05:31:56Z"
      }
    },
    "templateId": "<string>",
    "expiresAt": "<string>",
    "batchId": "<string>",
    "tag": "<string>",
    "reason": "<string>",
    "previewJobId": "<string>",
    "applyJobId": "<string>",
    "expected": {
      "accounts": 123,
      "totalAmount": 123
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Add accounts before starting the preview",
  "code": "NO_ACCOUNTS"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions",
  "code": "INSUFFICIENT_PERMISSIONS"
}

{
  "success": false,
  "statusCode": 404,
  "error": "Not Found",
  "message": "Job not found",
  "code": "JOB_NOT_FOUND"
}

{
  "success": false,
  "statusCode": 409,
  "error": "Conflict",
  "message": "The preview has already started",
  "code": "JOB_NOT_DRAFT"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

{
  "success": false,
  "statusCode": 503,
  "error": "Error",
  "message": "Mass credit is not available yet; nothing was changed",
  "code": "FEATURE_NOT_READY"
}