Set Mailbag Control ID

Assign a custom mailbag control ID to a parcel for external tracking and reconciliation purposes.

Endpoint

POST /v2/parcels/set-mailbagcontrolid

Request Body

Field	Type	Required	Constraints	Description
parcelId	long	Yes		Unique identifier of the parcel
mailbagControlId	string	Yes	Non-empty	Custom control ID string to assign to this parcel

{
  "parcelId": 987654321,
  "mailbagControlId": "ACME-2026050701"
}

Response

Returns a success boolean indicating the mailbag control ID was assigned.

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

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/parcels/set-mailbagcontrolid" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "parcelId": 987654321, "mailbagControlId": "ACME-2026050701" }'

C#

// .NET 10 — tag a parcel with a business-defined control ID for reconciliation
using System.Net.Http.Json;

var request = new
{
    parcelId = 987654321L,
    mailbagControlId = "ACME-2026050701"
};

var response = await http.PostAsJsonAsync(
    "https://rest.ecgrid.io/v2/parcels/set-mailbagcontrolid",
    request);
response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<bool>>();
if (result!.Data)
{
    Console.WriteLine($"Mailbag control ID assigned to parcel {request.parcelId}.");
}

Java

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

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

String body = "{ \"parcelId\": 987654321, \"mailbagControlId\": \"ACME-2026050701\" }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/parcels/set-mailbagcontrolid"))
    .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/parcels/set-mailbagcontrolid';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "parcelId": 987654321, "mailbagControlId": "ACME-2026050701" }),
});

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/parcels/set-mailbagcontrolid"

response = requests.post(
    url,
    json={ "parcelId": 987654321, "mailbagControlId": "ACME-2026050701" },
    headers=headers,
)

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

See Also

• Find Mailbag Control ID — look up parcels by their mailbag control ID
• Get Parcel — retrieve parcel metadata after assignment