Update Carbon Copy

Updates the status or direction of an existing carbon copy rule.

Endpoint

PUT /v2/carboncopies/update

Request Body

Field	Type	Required	Constraints	Description
ccId	integer	Yes	Must be an existing CC rule	Unique identifier of the carbon copy rule to update
status	Status	No	See ENUMs	New status for the rule (e.g., Active, Suspended)
direction	Direction	No	See ENUMs	New traffic direction for the rule

{
  "ccId": 1042,
  "status": "Suspended",
  "direction": "OutBox"
}

Response

Returns the updated carbon copy rule.

{
  "success": true,
  "data": {
    "ccId": 1042,
    "fromMailboxId": 101,
    "toMailboxId": 202,
    "status": "Suspended",
    "direction": "OutBox",
    "created": "2025-01-15T10:30:00Z"
  }
}

ENUMs

This endpoint uses the Status and Direction ENUMs. See ENUMs Reference for all valid values.

Code Examples

cURL

curl -X PUT "https://rest.ecgrid.io/v2/carboncopies/update" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "ccId": 1042, "status": "Suspended", "direction": "OutBox" }'

C#

// .NET 10 — Suspend a carbon copy rule
var request = new
{
    ccId = 1042,
    status = "Suspended"
};

using var response = await httpClient.PutAsJsonAsync(
    "https://rest.ecgrid.io/v2/carboncopies/update",
    request);

response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<CarbonCopyInfo>>();
Console.WriteLine($"CC Rule {result.Data.CcId} updated — Status: {result.Data.Status}");

Java

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

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

String body = "{ \"ccId\": 1042, \"status\": \"Suspended\", \"direction\": \"OutBox\" }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/carboncopies/update"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .PUT(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/carboncopies/update';

const response = await fetch(url, {
  method: 'PUT',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "ccId": 1042, "status": "Suspended", "direction": "OutBox" }),
});

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/carboncopies/update"

response = requests.put(
    url,
    json={ "ccId": 1042, "status": "Suspended", "direction": "OutBox" },
    headers=headers,
)

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

See Also

• Get Carbon Copy
• Create Carbon Copy
• List Carbon Copies
• Delete Carbon Copy
• ENUMs Reference