CommDefaultMailbox

Sets the default mailbox for a communication channel, determining which mailbox receives inbound EDI when no more-specific routing rule applies.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

bool CommDefaultMailbox(string SessionID, int CommID, int MailboxID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token from Login()
CommID	int	Yes	Unique identifier of the communication channel
MailboxID	int	Yes	Mailbox ID to set as the default for this comm channel

Response

Returns true if the default mailbox was successfully updated; throws a SOAP fault on failure.

<!-- Example response XML -->
<CommDefaultMailboxResult>true</CommDefaultMailboxResult>

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
using ECGridOSClient;

var client = new ECGridOSPortTypeClient();

// Set mailbox 200 as the default for comm channel 4521
bool success = await client.CommDefaultMailboxAsync(
    sessionID,
    CommID: 4521,
    MailboxID: 200);

if (success)
{
    Console.WriteLine("Default mailbox updated successfully.");
}

Java

// JAX-WS generated client
// wsimport -s src https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL

ECGridOS service = new ECGridOS();
ECGridOSPortType port = service.getECGridOSPort();

var result = port.CommDefaultMailbox(sessionID /*, additional params */);
System.out.println(result);

Node.js

// npm install soap
import soap from 'soap';

const WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL';
const client = await soap.createClientAsync(WSDL);

const [result] = await client.CommDefaultMailboxAsync({
  SessionID: sessionId,
  // additional params
});
console.log(result);

Python

# pip install zeep
from zeep import Client

WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL'
client = Client(WSDL)

result = client.service.CommDefaultMailbox(
    SessionID=session_id,
    # additional params
)
print(result)

REST Equivalent

See Update Comm Config — PUT /v2/comms/update-config.