TMF629 v4 Customer Management API (Non-Extensible)

The Customer Management API (TMF629) provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval and deletion of customers. Using this API you can perform the following operations on the customer account.

  • Retrieve the list of customer accounts from the system
  • Get the customer account details based on conditions or id parameter
  • Create a customer account
  • Update an existing customer account
  • Delete an existing customer account

The Customer Management API is certified by TM Forum.

Certification

From the Spring'26, extensibility is enabled for the TMF629 API. See TMF629 v4 Customer Management API (Extensible).

For the Spring'26 and Summer'26 releases, TMF629 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 TMF629 v4 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.
  • Starting from the Winter ’27 release, support will be limited to the extensible TMF629 API.

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

  • The CommsCloud license must be enabled to invoke the TMF629 API.

TMF629 v4 API uses the following URL format: {https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/customermanagement/v4/customer.

To access and use the TMF629 v4 API:

  1. Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
  2. Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
  3. Trigger the API call. Refer the above section for sample URL.
  4. Use the TMF629 v4 available resources and API endpoints.