TM Forum Open API

Customer Management API

Create, find and update customer records

The Customer Management API is designed to provide businesses with a structured and standardized mechanism for handling customer-related data.

  • Customer onboarding
  • Profile updates
  • CRM sync

What you can do with this API

Ready to test? Jump to the sample call and the API reference, where you can try every endpoint. Start testing
Read the full API overview

Customer Management API

The Customer Management API is designed to provide businesses with a structured and standardized mechanism for handling customer-related data. It enables enterprises to create, update, retrieve, delete, and notify events related to customers and their accounts, ensuring efficient customer relationship management.

Key Capabilities

  1. Customer Lifecycle Management:
    • Supports the full customer journey, from onboarding to account management and deletion.
    • Allows enterprises to keep customer records accurate and up to date.
  2. Customer Account Handling:
    • Enables businesses to manage customer accounts, including billing, subscriptions, and financial transactions.
    • Supports account retrieval, ensuring businesses can access customer details when needed.
  3. Event Notification System:
    • Sends real-time notifications or updates related to customer interactions, purchases, or account changes.
    • Helps businesses automate alerts for renewals, modifications, and other account activities.
  4. Flexible Customer Definition:
    • Customers can be individuals, organizations, or service providers that interact with the enterprise.
    • Allows tracking of resellers and partners who distribute the enterprise’s products or lease resources.
  5. Customer Resource Data Management:
    • Handles identification and financial details of customers, ensuring accurate financial tracking.
    • Stores vital information such as name, status, validity, description, contact details, and credit profile.
  6. Integration with Other Business Functions:
    • Works seamlessly with CRM systems, billing platforms, and accounting software to maintain consistency in customer records.
    • Ensures businesses have a centralized customer data hub for better decision-making.

Use Cases of the Customer Management API

  • Automating Customer Onboarding: Enterprises can onboard new customers efficiently using API-driven processes.
  • Managing Customer Billing Accounts: Enables tracking of financial transactions, payments, and outstanding balances.
  • Handling Subscription Services: Supports management of customers subscribed to various services.
  • Customer Service Optimization: Helps service teams access customer data for resolving inquiries and issues.
  • Partnership & Reseller Tracking: Allows tracking of partner relationships, helping enterprises manage vendor and reseller engagements.

This API essentially serves as a core component in customer relationship management, ensuring that businesses maintain accurate and up-to-date customer profiles.

Questions about the Customer Management API

What can I do with the Customer Management API?

The Customer Management API is designed to provide businesses with a structured and standardized mechanism for handling customer-related data.

  • List or find Customer objects (GET /customer)
  • Creates a Customer (POST /customer)
  • Retrieves a Customer by ID (GET /customer/{id})
  • Updates partially a Customer (PATCH /customer/{id})
  • Deletes a Customer (DELETE /customer/{id})
Which inputs does each call to the Customer Management API need?
  • POST /customer: requires action
  • GET /customer/{id}: requires id, name
  • PATCH /customer/{id}: requires id, action
  • DELETE /customer/{id}: requires id

Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.

Which errors can the Customer Management API return?
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 405: Method Not allowed
  • 409: Conflict
  • 500: Internal Server Error

On 401, request a new access token and retry.

Where is the Customer Management API available?

Customer Management is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.

Which standard does the Customer Management API follow?

It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.

Related APIs

Sample call

From the published OpenAPI specification. Replace the placeholders with your app's credentials and real values.

Call the API

curl -X GET https://api.ooredoo.com/tmf-api/customerManagement/v1/customer \
  -H "Authorization: Bearer $ACCESS_TOKEN"

API reference

Try any endpoint in the sandbox