PUT

/Communication

When to Use

  • Email Address Updates: Change investor email for distribution notifications while maintaining global uniqueness
  • Phone Number Corrections: Update mobile numbers for SMS transaction confirmations and two-factor authentication
  • Ownership Transfer: Move communication from person-level to entity-level for organizational changes
  • Compliance Corrections: Fix communication formatting to meet regulatory notification requirements
  • Contact Method Migration: Change communication type classification when contact preferences update

Common Scenarios

  • Email Verification Update: Change investor email address after verification process while maintaining distribution notification continuity
  • Phone Number Refresh: Update mobile number for SMS two-factor authentication and transaction confirmation delivery
  • Organisational Restructuring: Transfer communication ownership from person to organisation during corporate trustee appointments
  • Data Quality Improvement: Correct phone number formatting to E.164 international standard for reliable SMS delivery
  • Contact Preference Changes: Update communication type from landline to mobile for improved notification responsiveness

Prerequisites

  • Valid Bearer token with communication update permissions
  • Communication record must exist (use communicationID or externalCommunicationId to identify)
  • Target entity (if changing ownership) must exist
  • Understanding of exclusive ownership and email uniqueness rules

Considerations

  • Complete Replacement: Provide all fields - missing fields may be cleared
  • Email Uniqueness: Email addresses must remain unique across the entire system
  • External ID Immutability: externalCommunicationId cannot be changed after creation
  • Exclusive Ownership: Communication can only belong to ONE entity at a time

Description

Updates an existing communication record with new information. This endpoint performs a complete replacement of the communication data, so include all fields you want to retain.

Advanced Resource: Communication records can be updated independently via this endpoint or managed through BizEntity operations. Use this endpoint for direct communication modifications, ownership transfers, or updating contact details for compliance purposes.

⚠️ Complete Replacement Pattern

This endpoint replaces the entire communication record. Always retrieve the current communication first, modify the required fields, then send the complete updated object.

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
7G platform identifier for communication record to update. Cannot be changed - used only for record targeting.
externalCommunicationId
 string(50)
Optional
Your external identifier for this communication record. Cannot be changed after creation.
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)
Updated communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID >
integer
Updates communication linkage to business entity. Use when transferring communication ownership or maintaining entity-level association for investor correspondence.
externalBizEntityId >
string(50)
Your external ID for the business entity (alternative to bizEntityID).
PersonID >
integer
Updates communication linkage to individual person. Use when transferring ownership or maintaining person-specific contact information.
externalPersonId >
string(50)
Your external ID for the person (alternative to personID).
OrganisationID >
integer
Updates communication linkage to organisation. Use when transferring ownership or maintaining corporate-level contact information.
externalOrganisationId >
string(50)
Your external ID for the organisation (alternative to organisationID).
CommunicationID
integer
7G platform identifier for communication record to update. Cannot be changed - used only for record targeting.
externalCommunicationId
string(50)
Optional
Your external identifier for this communication record. Cannot be changed after creation.
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)
Updated communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID
integer
Updates communication linkage to business entity. Use when transferring communication ownership or maintaining entity-level association for investor correspondence.
externalBizEntityId
string(50)
Your external ID for the business entity (alternative to bizEntityID).
PersonID
integer
Updates communication linkage to individual person. Use when transferring ownership or maintaining person-specific contact information.
externalPersonId
string(50)
Your external ID for the person (alternative to personID).
OrganisationID
integer
Updates communication linkage to organisation. Use when transferring ownership or maintaining corporate-level contact information.
externalOrganisationId
string(50)
Your external ID for the organisation (alternative to organisationID).

Entity Ownership Transfer

To transfer communication ownership, provide the new entity association:

  • Clear current ownership by setting all entity IDs to null
  • Set new owner using bizEntityID, personID, or organisationID
  • Only one entity association is allowed per communication record
Important: Communication ownership changes affect compliance notifications and investor correspondence routing.

Example Requests

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

Response Examples

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