TMF671 v4 Promotion Management API

The Promotion Management API (TMF671) offers a standardized way for service providers to configure and manage promotions. Using the TMF671 API, service providers can determine, based on predefined criteria, whether promotions such as additional discounts, vouchers, bonuses, or gifts can be applied.

The Promotion Management API is certified by TM Forum.

Certification

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

Note

Access Methods

For the Spring’26 and Summer’26 releases, TMF671 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 TMF671 v4 API MuleSoft endpoints.
Direct Access: Bypass Mule Gateway using Connect/Apex REST endpoints.
- See TMF671 v4 Use Cases section for sample URLs and payloads.
- See TMF671 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 Salesforce platform.

Prerequisites

Enable CommsCloud Advanced and RLM (Product discovery) licenses. Add Enterprise Edition, B2CLoyaltyManagementPlusAddon, and ContextService Admisn Psl (Permset License).
Set up RLM. See Product Discovery Setup.
Set up Global Promotions Management.
Set up Configuration Rules.

Sample Apex URL (Direct Access Method)

TMF671 v4 API uses this URL format:

{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion.

Use TMF671 v4 API

To access and use the TMF671 v4 API:

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