POST

/Communication

When to Use

  • Create email communications for investor notifications and distribution statements
  • Set up phone and mobile contacts for transaction confirmations
  • Add communications during investor onboarding workflows
  • Bulk import communications from legacy systems using external IDs

Prerequisites

  • Target entity (BizEntity, Person, or Organisation) must exist before creating communication

Considerations

  • Each communication must belong to exactly ONE entity (BizEntity, Person, or Organisation)
  • Email addresses must be unique across the entire system
  • communicationTypeID via common/lookup determines validation rules for format and content

Description

Creates a new communication record representing contact methods for entities (email addresses, phone numbers, mobile numbers, fax numbers).

Advanced Resource: Communication records can be created independently via this endpoint or automatically as part of BizEntity operations. Use this endpoint for bulk imports or managing cross-entity communication relationships.

Email Uniqueness: Email addresses must be globally unique across the entire system. Phone, mobile, and fax numbers allow duplicates for shared lines. Refer to Common/Lookup (Category: CommunicationType) for 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 Communications PUT Update Communication POST Create BizEntity