Update a PnL card (visibility and/or description)

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/cards/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/cards/{id}"

payload = { "description": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>'})
};

fetch('https://api.hyperprop.com/platform/v1/cards/{id}', 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/cards/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.hyperprop.com/platform/v1/cards/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hyperprop.com/platform/v1/cards/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/cards/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "Card updated",
  "data": {
    "card": {
      "id": "<string>",
      "userId": "<string>",
      "accountId": "<string>",
      "tradeRef": {
        "entryOrderId": "<string>",
        "exitOrderId": "<string>",
        "entryOrderIds": [
          "<string>"
        ],
        "exitOrderIds": [
          "<string>"
        ]
      },
      "periodRef": {},
      "snapshot": {
        "symbol": "ES",
        "contract": "ESM6",
        "contractName": "E-mini S&P 500",
        "side": "long",
        "quantity": 2,
        "entryPrice": 5210.25,
        "exitPrice": 5215.75,
        "openedAt": "2026-05-22T13:01:14.000Z",
        "closedAt": "2026-05-22T13:42:09.000Z",
        "pnlGross": 550,
        "fees": 6,
        "pnlNet": 544,
        "pricePerPoint": 50,
        "feePerSide": 1.5,
        "currency": "USD",
        "accountLabel": null
      },
      "description": "First trade with my new setup",
      "revokedAt": "<string>",
      "revokedReason": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

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

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

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