Send Communication

This endpoint is used to send a digital communication to a customer. It can send one item to multiple customers, multiple items to one customer, or a combination of the two.

Definition

Route: /communications/send
Method: POST
OperationId: SendCommunication

Permissions

The user must be a member of one of the following groups to send communications.

client:admin
communication:manager
communication:sender

Request

Headers

Name	Description	Notes
accept	The expected format of the response	`application/json`
osg-client-id	The unique identifier assigned to your organization
client_customer_id	The unique identifier assigned to your client
correlation_id	The unique identifier for correlation

Body

SendCommand

Tip

You can submit multiple communications at once by passing an array of SendCommand objects.

Responses

Success

Status	Description	Body
202	The request was successful and is being processed.	SendResult

Failures

Status	Description	Body
400	The request was invalid.	SendResult
401	The request was not authorized.	None
403	The request was not allowed.	None
500	An unexpected error occurred.	None

Schemas

[
  {
    "communication_type": "string",
    "communication_sub_type": "string",
    "delivery_method": "string",
    "account_number" : "string",
    "account_discriminator": "string",
    "email_address" : "string",
    "email_options" : "string",
    "mailing_address" : "Object::Address",
    "client_data" : {
      "items": [
        "Object::ClientDataEntry"
      ]},
    "caller": "Object::Caller"
  }
]

[
  {
    "communication_type": "osg-test-letters",
    "communication_sub_type": "welcome-letter",
    "delivery_method": "email",
    "account_number" : "1234567890",
    "account_discriminator": "1",
    "email_address" : "test@osgconnect.com",
    "email_options" : "PrintOnFailure",
    "mailing_address" : {
        "address_line1" : "HeadQuarters",
        "address_line2" : "OSG",
        "address_line3" : "1234 Main St",
        "address_line4" : "Suite 1",
        "city" : "Carol Stream",
        "state": "IL",
        "postal_code": "60188",
        "postal_code_extension": "0000",
        "address_country": "US"
    },
    "client_data" : {
      "items": [
        { "name": "customer-name", "value": "Test User" },
        { "name": "reference-number", "value": "9876543210" },
        { "name": "local-branch", "value": "Chicago, IL" },
        { "name": "customer-service-phone", "value": "1-630-597-9100" }
      ]
    }
  }
]

CommunicationType*

The product group to use. This is a logical grouping of products specific to the caller's organization. The available options will be provided by OSG.

Examples: 'Letter' or 'Statement'

CommunicationSubType*

The product to use. This identifies the template that will be used for this communication. The available options will be specific to the caller and the selected CommunicationType.

If it is not provided, the value default will be used.

DeliveryMethod*

The method(s) to deliver the communication. The available options depend on the caller's organization configuration as well as the selected CommunicationType and CommunicationSubType.

It must be one of the following value:

Email
- This communication should be sent using email.
Print
- This communication should be printed and mailed.
EmailAndPrint
- This communication should be sent by email as well as printed and mailed.

You can specify multiple methods by separating them with commas. Example:Email,Print.

Caution

This sets the primary delivery method to use for this communication. You must set this to only Email if the communication should only be printed and mailed when email delivery fails.

Setting a failed email to be diverted to print is set using EmailOptions.

AccountNumber*

The account number or identifier of the subject of this communication. For example, a financial institution send statements would use the account number of the account the statement applies to.

AccountDiscriminator **

The discriminator to use to identify a specific communication when the same AccountNumber is used on multiple communications.

For example, some financial institutions have the same AccountNumber for every account. A suffix is added to the account number to identify a specific checking or savings account. In these cases this element would contain that suffix.

EmailAddress**

The email address to which the communication will be sent. It is required if the DeliveryMethod includes 'Email'.

EmailOptions**

The options used to configure how email communication requests are processed. This element can be set to Default or omitted if the default settings for the caller should be used.

Option	Description	Default
`LazyValidation`	The requirement for the `MailingAddress` is only checked when email delivery fails.	False
`PrintOnFailure`	This communication should be printed and mailed if email delivery fails.	The configured value for the caller's `CommunicationSubType`.

MailingAddress**

The mailing address to which the communication will be sent. This field is required if the DeliveryMethod includes Print or the EmailOptions include PrintOnFailure. If the email option is not selected the default behavior is based on the configuration of the CommunicationSubType

Address

ClientData

A collection of key-value pairs providing the data used in the communication template. The keys and values are specific to your caller, CommunicationType, and CommunicationSubType.

{
  "communication_id": "string",
  "account_number": "string",
  "account_discriminator": "string",
  "result": {
    "is_success": "boolean",
    "errors": [],
    "sent_on_utc": "string",
    "trace_id":"string",
    "correlation_id": "string"
  }
}

{
  "communication_id": "00000000-0000-0000-000000000000",
    "account_number": "1234567890",
    "account_discriminator": "1",
  "result": {
    "is_success": true,
    "errors": [],
    "sent_on_utc": "2025-01-17T00:05:30Z",
    "trace_id": "00000000-0000-0000-0000-000000000000",
    "correlation_id": "test-request-1"
  }
}

CommunicationId*

The unique identifier of the sent communication. This value is required to view or download the communication and to send notifications related to it.

AccountNumber*

Copied from the request. The account number of the customer to whom the communication was sent.

AccountDiscriminator

Copied from the request. The discriminator used to differentiate between multiple accounts with the same AccountNumber.

Result

ApiResult

Table of Contents

Send Communication

Definition

Permissions

Request

Headers

Body

Tip

Responses

Success

Failures

Schemas

SendCommunicationCommand

SendCommunicationResult

CommunicationId*

AccountNumber*

AccountDiscriminator

Result