The Document Management API (TMF667) offers a standardized approach for handling documents, especially in the context of partnerships. It enables both document creation and retrieval.
This API manages key metadata associated with a document, including details like related parties (for example, author, reviewer, publisher), creation date, version, and lifecycle status. The actual content of the document is referenced by an associated Attachment, with binary content typically accessible through the Attachment.url attribute, which may point to a file or an HTTPS reference.
The Document Management API is certified by TM Forum.
For the Spring’26 and Summer’26 releases, TMF667 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 TMF667 v4 API MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
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
The CommsCloud license must be enabled to invoke the TMF667 v4 API.
j