---
schema_version: "1"
id: 776925e57b0fa1659808c14eb670c5424a9328ef132019e8951719c71c7fcf48
title: TMF629 v4 Customer Management API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/TMF629/TMF629.md
canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/TMF629.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: b6e324637ed1e836f57846f29a8ccf82baba705be5c216b65cf929c840d71b49
products:
  - Communications Cloud TM Forum API
  - Industries Integrations
---
# TMF629 v4 Customer Management API

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](https://developer.salesforce.com/media/APIBadge.GOLDwNewLogo.png '{"class": "image-md"}')

From the Spring'26, extensibility is enabled for the TMF629 API. See [Extensibility for TMF629 v4 Customer Management](https://developer.salesforce.com/docs/industries/communications/Extensibility/TMF629_extensibility.md).

**note:** - For TMF Open API release and specification version, see [Industry API Version](https://developer.salesforce.com/docs/industries/communications/industry_api_version.md).

## Access Methods

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](https://developer.salesforce.com/docs/industries/communications/references/tmf629?meta=Summary) section for details on TMF629 v4 MuleSoft endpoints.
- **Direct Access:** Bypass Mule Gateway using Connect/Apex REST endpoints.
  - See [TMF629 v4 Use Cases](https://developer.salesforce.com/docs/industries/communications/guide/TMF629use-cases.html) section for sample URLs and payloads.
  - See [TMF629 v4 Resource Mappings](https://developer.salesforce.com/docs/industries/communications/guide/tmf629_resource_mapping.html) section for parameter descriptions.

**important:** - 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.

## Available In

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

## Prerequisites

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

## Extensibility

For extensibility features, see [Extensibility for TMF629 v4 Customer Management](https://developer.salesforce.com/docs/industries/communications/Extensibility/TMF629_extensibility.md).

## Sample Apex URL (Direct Access Method)

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

## Use TMF629 v4 API

To access and use the TMF629 v4 API:

1. Authorize and use a connected app and an OAuth 2.0 authorization flow. See [Authorize Access](https://developer.salesforce.com/docs/industries/communications/authorization.md).
2. Trigger the API call. Refer the above section for sample URL.
3. Use the TMF629 v4 available resources and API endpoints.
   - See [TMF629 v4 Use Cases](https://developer.salesforce.com/docs/industries/communications/guide/TMF629use-cases.html) section for sample URLs and payloads.
   - See [TMF629 v4 Resource Mappings](https://developer.salesforce.com/docs/industries/communications/guide/tmf629_resource_mapping.html) section for parameter descriptions.