POST
/communication
Usage Notes
When
- Create communications for bulk import from external systems
- Add contact methods to existing entities outside BizEntity workflow
- Direct communication creation with specific entity association
Requirements
- Target entity must exist (provide BizEntityID, PersonID, or OrganisationID)
- Only one entity association allowed per communication
- CommunicationTypeID required (query Common/Lookup for values)
Notes
- Email addresses must be globally unique - duplicates rejected
- Phone/mobile/fax numbers may be duplicated across records
- ExternalCommunicationId cannot be changed after creation
Description
Creates a communication record associated with a BizEntity, Person, or Organisation. Each communication belongs to exactly one entity; provide only one entity ID.
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
| Content-Type | application/json | Content 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
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
Your unique identifier for this communication record. Must be unique across the entire system if provided.
CommunicationTypeID
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
Actual communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID
Links communication to business entity for investor correspondence and compliance notifications. Use when communication serves BizEntity-level operations (distributions, transactions, regulatory reporting).
externalBizEntityId
Your external ID for the business entity (alternative to bizEntityID).
PersonID
Links communication to individual person for personal contact purposes. Use when communication is person-specific rather than entity-level (individual notifications, personal correspondence).
externalPersonId
Your external ID for the person (alternative to personID).
OrganisationID
Links communication to organisation for corporate-level contact. Use when communication serves organisational purposes (corporate trustee correspondence, company notifications).
externalOrganisationId
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
bash
# Create email communication for business entity
curl -X POST "https://api.7g.com.au/communication" \
-H "Content-Type: application/json" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0" \
-d '{
"communicationID": 0,
"externalCommunicationId": "EMAIL-001",
"communicationTypeID": 2,
"name": "john.smith@example.com",
"bizEntityID": 12345
}'
# Create mobile phone for person using external ID
curl -X POST "https://api.7g.com.au/communication" \
-H "Content-Type: application/json" \
-H "Authorization: {accessToken}" \
-H "Version: 2.0" \
-d '{
"communicationTypeID": 1,
"name": "+61412345678",
"externalPersonId": "EXT-PERSON-001"
}'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
}
}