POST

/Communication

When to Use

  • Investor Onboarding: Create primary email communication during initial BizEntity setup for distribution notifications
  • Multi-Channel Contact Setup: Establish email, mobile, and fax communications for comprehensive investor reach
  • Regulatory Compliance: Add verified email addresses for CRS/FATCA automated reporting delivery
  • Legacy System Migration: Bulk import communications with ExternalCommunicationId for system transition tracking
  • Corporate Contact Management: Create organisation-level communications for corporate trustee correspondence

Common Scenarios

  • New Investor Setup: Create email communication as part of BizEntity onboarding for distribution and transaction notifications
  • Multi-Method Contact: Establish email for formal correspondence, mobile for SMS alerts, and fax for legacy regulatory documents
  • Corporate Trustee Communication: Set up organisation-level email for corporate trustee correspondence and ASIC notifications
  • External System Integration: Import communications with ExternalCommunicationId to maintain dual-ID tracking for CRM synchronization
  • Compliance Notification Setup: Add verified email addresses specifically for CRS/FATCA automated reporting delivery

Prerequisites

  • Valid Bearer token with communication creation permissions
  • Target entity must exist before creating communication

Considerations

  • Exclusive Ownership: Each communication record must belong to exactly ONE entity
  • Email Uniqueness: Email addresses must be unique across the entire system
  • External IDs must be unique across the entire system
  • Communication records are essential for compliance notifications and investor correspondence

Description

Creates a new communication record and associates it with an existing entity. Communication records are essential for investor notifications, compliance communications, and maintaining contact with stakeholders in the Australian financial services context.

Advanced Resource: Communication records can be created independently via this endpoint or automatically as part of BizEntity operations. Use this endpoint for direct communication management, bulk imports, or when synchronizing contact data from external systems.

Communication Classification

Communication types determine validation rules and uniqueness constraints:

  • Email Addresses: Must be globally unique, validated for RFC 5322 format
  • Phone Numbers: Support international formats with country codes (e.g., +61)
  • Mobile Numbers: Preferred for two-factor authentication and urgent notifications
  • Fax Numbers: Legacy support for regulatory document delivery

Refer to Common/Lookup endpoint (Category: CommunicationType) for current type classifications.

Required Headers - See Authentication

HeaderValueDescription
Authorization{accessToken}Bearer token for API access
Version2.0API version identifier
Content-Typeapplication/jsonContent type for request body

Request Body

Parameter Type Required Description
CommunicationID
 integer
Optional
7G platform identifier assigned upon successful creation. Must be explicitly set to 0 or null for POST operations to prevent update attempts. Referenced across platform for relationship linkage and audit trails.
externalCommunicationId
 string(50)
Optional
Your unique identifier for this communication record. Must be unique across the entire system if provided.
CommunicationTypeID >
integer
Classification of communication method determining system routing, validation rules, and uniqueness requirements. Email addresses must be globally unique across the platform; phone numbers allow duplicates for shared lines.
name >
string(255)
Actual communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID >
integer
Links communication to business entity for investor correspondence and compliance notifications. Use when communication serves BizEntity-level operations (distributions, transactions, regulatory reporting).
externalBizEntityId >
string(50)
Your external ID for the business entity (alternative to bizEntityID).
PersonID >
integer
Links communication to individual person for personal contact purposes. Use when communication is person-specific rather than entity-level (individual notifications, personal correspondence).
externalPersonId >
string(50)
Your external ID for the person (alternative to personID).
OrganisationID >
integer
Links communication to organisation for corporate-level contact. Use when communication serves organisational purposes (corporate trustee correspondence, company notifications).
externalOrganisationId >
string(50)
Your external ID for the organisation (alternative to organisationID).
CommunicationID
integer
Optional
7G platform identifier assigned upon successful creation. Must be explicitly set to 0 or null for POST operations to prevent update attempts. Referenced across platform for relationship linkage and audit trails.
externalCommunicationId
string(50)
Optional
Your unique identifier for this communication record. Must be unique across the entire system if provided.
CommunicationTypeID
integer
Classification of communication method determining system routing, validation rules, and uniqueness requirements. Email addresses must be globally unique across the platform; phone numbers allow duplicates for shared lines.
name
string(255)
Actual communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID
integer
Links communication to business entity for investor correspondence and compliance notifications. Use when communication serves BizEntity-level operations (distributions, transactions, regulatory reporting).
externalBizEntityId
string(50)
Your external ID for the business entity (alternative to bizEntityID).
PersonID
integer
Links communication to individual person for personal contact purposes. Use when communication is person-specific rather than entity-level (individual notifications, personal correspondence).
externalPersonId
string(50)
Your external ID for the person (alternative to personID).
OrganisationID
integer
Links communication to organisation for corporate-level contact. Use when communication serves organisational purposes (corporate trustee correspondence, company notifications).
externalOrganisationId
string(50)
Your external ID for the organisation (alternative to organisationID).

Entity Ownership Rules

Each communication record must be associated with exactly one entity:

  • Provide bizEntityID OR externalBizEntityId for business entities
  • Provide personID OR externalPersonId for individuals
  • Provide organisationID OR externalOrganisationId for organisations
Important: Only one entity association is allowed per communication record. Multiple entity associations will result in an error.

Example Requests

json
{
  "communicationID": 0,
  "externalCommunicationId": "EMAIL-001",
  "communicationTypeID": 1,
  "name": "john.smith@example.com",
  "bizEntityID": 789,
  "externalBizEntityId": null,
  "personID": null,
  "externalPersonId": null,
  "organisationID": null,
  "externalOrganisationId": null
}

Response Examples

json
{
  "result": true,
  "message": "Communication created successfully",
  "recordCount": 1,
  "data": {
    "communicationID": 12345,
    "externalCommunicationId": "EMAIL-001",
    "communicationTypeID": 1,
    "name": "john.smith@example.com",
    "bizEntityID": 789,
    "externalBizEntityId": null,
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}
GET Get Communication PUT Update Communication DELETE Delete Communication