The Party Management API (TMF632) provides a standardized mechanism for party management, such as creation, update, retrieval, and deletion of parties.
TMF632 supports these resources.
- Individual — A person. Individual records are stored as Salesforce Contact records.
- Organization — A company or other organization. Organization records are stored as Salesforce Account records.
Using this API you can perform the following operations on individual and organization parties.
- Retrieve the list of parties from the system
- Get party details based on conditions or an ID parameter
- Create a party (individual or organization)
- Update an existing party
- Delete an existing party
note: - For TMF Open API release and specification version, see Industry API Version.
Access Methods
Access TMF632 v5 API using Direct Access Connect/Apex REST endpoints.
- See TMF632 v5 Use Cases for sample URLs and payloads.
- See TMF632 v5 Resource Mappings for parameter descriptions.
important: Starting from the Winter ’27 release, only the Direct Access option is supported for this API.
Available In
This API is available in the Salesforce platform.
Prerequisites
- Required: CommsCloudTMFAPI or the CommsCloud platform license.
- Optional: CommunicationsCloudTMFAPIAddOn-1 add-on license.
- Access check:
IndustriesComms.orgHasCommsTMFAPIAccess. - Minimum API version: 264.
- To add an Account-to-Account relationship on an Organization resource, create a PartyRoleRelation.
- An individual party contact that has no associated related accounts (a private contact) cannot be linked with an organization party Account.
- If you implement Apex extensibility hooks, annotate the custom Apex class with
@PermGuard('IndustriesComms.orgHasCommsTMFAPIAccess').
Extensibility
For extensibility features, see Extensibility for TMF632 v5 Party Management.
Sample Apex URL (Direct Access Method)
TMF632 v5 API uses the following URL formats.
| TMF632 Resource | Sample URL |
|---|---|
| Individual | {https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/partymanagement/v5/individual |
| Organization | {https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/partymanagement/v5/organization |
Use TMF632 v5 API
To access and use the TMF632 v5 API:
- Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
- Trigger the API call. Refer to the preceding section for sample URLs.
- Use the TMF632 v5 API resources and endpoints.
- See TMF632 v5 Use Cases for sample URLs and payloads.
- See TMF632 v5 Resource Mappings for parameter descriptions.
- Based on the requirements, extend TMF632 v5 API. See Extensibility for TMF632 v5 Party Management.