Update Description

Updates the human-readable description label for a trading partner ECGrid ID.

Endpoint

POST /v2/ids/tp-update-description

Request Body

Field	Type	Required	Constraints	Description
ecGridId	integer	Yes	Must be a valid ECGrid ID	The ECGrid ID to update
description	string	Yes	—	New description text for the trading partner

{
  "ecGridId": 123456,
  "description": "Acme Corp — Production EDI"
}

Response

Returns a success boolean confirming the description was updated.

{
  "success": true,
  "data": true
}

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/ids/tp-update-description" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "ecGridId": 123456, "description": "Acme Corp — Production EDI" }'

C#

// .NET 10 — update the display description for a trading partner ECGrid ID
using var client = httpClientFactory.CreateClient("ECGrid");

var request = new
{
    ecGridId = 123456,
    description = "Acme Corp — Production EDI"
};

var response = await client.PostAsJsonAsync(
    "https://rest.ecgrid.io/v2/ids/tp-update-description", request);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<bool>>();
Console.WriteLine($"Description updated: {result!.Data}");

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");

String body = "{ \"ecGridId\": 123456, \"description\": \"Acme Corp — Production EDI\" }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/ids/tp-update-description"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = 'https://rest.ecgrid.io/v2/ids/tp-update-description';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "ecGridId": 123456, "description": "Acme Corp — Production EDI" }),
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
url = "https://rest.ecgrid.io/v2/ids/tp-update-description"

response = requests.post(
    url,
    json={ "ecGridId": 123456, "description": "Acme Corp — Production EDI" },
    headers=headers,
)

response.raise_for_status()
print(response.json())

See Also

• Get ID
• Update ID
• Update Data Email