PUT
/Communication
When to Use
- Update email addresses or phone numbers
- Change communication type classification (email, phone, mobile, fax)
- Transfer communication ownership between entities
- Correct formatting of contact information
Prerequisites
- Communication record must exist (identified by communicationID or externalCommunicationId)
Considerations
- communicationID is required and must match existing record
- externalCommunicationId cannot be changed after creation
- Email addresses must remain unique across the entire system
- Communication can only belong to ONE entity at a time
Description
Updates an existing communication record by completely replacing its data. Include all fields to avoid clearing existing values.
Advanced Resource: Communication records can be updated independently via this endpoint or managed through BizEntity operations. Use this endpoint for direct communication modifications or bulk updates.
Complete Replacement: This endpoint replaces the entire communication record. Always GET the current communication first, modify specific fields, then PUT the complete object back.
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 | 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
7G platform identifier for communication record to update. Cannot be changed - used only for record targeting.
externalCommunicationId
Your external identifier for this communication record. Cannot be changed after creation.
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
Updated communication value (email address, phone number with country code, or fax number). Format validation applied based on communicationTypeID classification.
BizEntityID
Updates communication linkage to business entity. Use when transferring communication ownership or maintaining entity-level association for investor correspondence.
externalBizEntityId
Your external ID for the business entity (alternative to bizEntityID).
PersonID
Updates communication linkage to individual person. Use when transferring ownership or maintaining person-specific contact information.
externalPersonId
Your external ID for the person (alternative to personID).
OrganisationID
Updates communication linkage to organisation. Use when transferring ownership or maintaining corporate-level contact information.
externalOrganisationId
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
}
}