TMF651 v4 Agreement Management API

The TMF651 API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.
The TMF651 API allows the following operations.
- Creating, updating, and querying of agreement instances.
- Creating, updating, and querying of agreement specifications, that act as templates for agreement instances.

The Agreement Management API is certified by TM Forum.

Certification

Using the TMF651 API for agreement specification you can perform the following operations.
- Retrieve the list of agreement specifications from the system
- Get the agreement specification details
- Create an agreement specification
- Update an existing agreement specification
- Delete an existing agreement specification
Using the TMF651 API for agreements you can perform the following operations.
- Retrieve the list of agreement instances from the system
- Get the agreement instance details
- Create an agreement instance
- Update an existing agreement instance
- Delete an existing agreement instance

For TMF Open API release and specification version, see Industry API Version.

Note

Access Methods

For the Spring’26 and Summer’26 releases, TMF651 v4 API can be accessed using either of the following methods.

Mule Gateway: Access API through standard MuleSoft endpoints. For sample URLs, payloads, and parameter descriptions, see Reference section for details on TMF651 v4 API MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
- See TMF651 v4 Use Cases section for sample URLs and payloads.
- See TMF651 v4 Resource Mappings section for parameter descriptions.

Starting from the Winter ’27 release, only the Direct Access option will be supported. The MuleSoft gateway option will be deprecated, and customers must update their integrations to use the Connect/Apex REST endpoints for continued access to the inbound APIs.

Important

Available In

This API is available in the managed package and Salesforce platform.

Prerequisites

Required Platform license: Contract Management.
Required Addon: ContractManagementAddon, DocGenDesigner.
Enable Salesforce Contracts on the org.
Required Org permissions: ContractMgmt, DocGen, and CommsCloud.

Sample Apex URL (Direct Access Method)

Refer to the following table, which lists sample URL for the respective TMF651 API resources.

TMF651 Resource	Sample URL
Agreement Specification	{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreementspecification
Agreement	{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/agreementmanagement/v4/agreement

Use TMF651 v4 API

To access and use the TMF651 v4 API:

Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
Trigger the API call. Refer the above section for sample URL.
Use the TMF651 v4 API resources and API endpoints.
- See TMF651 v4 Use Cases section for sample URLs and payloads.
- See TMF651 v4 Resource Mappings section for parameter descriptions.