Public
Documentation Settings

Sangam CRM API Integration

Introduction

This document provides guidance on how to integrate the Sangam CRM API with a website or third-party software.

In order to integrate the Sangam CRM API with your website or third-party software, you will need to have access to the Sangam CRM URL and a valid API token or key. These credentials are typically used to authenticate your requests to the API and to identify your Sangam CRM account.

CRM URL and Token Info

{{crm-url}} : /api/v1

  • Your CRM URL should be your Sangam CRM domain name, such as enjay.sangam.com.

{{token}} : your-api key

Generate API key

  • An API key is a unique identifier that allows a user or application to access an API.
  • The API key for Sangam CRM is given by the Sangam CRM administrator or project-in charge who has the required permissions to generate and handle API keys.
  • Here's a document link that provides steps for generating a token key and API
    URL:https://docs.google.com/document/d/1DeT2fj87sDY5sG8iNUKWslmyePdhl7KqS83b0LHWW_o/edit
  • You can pass Authorization in the body also just pass with the parameter authorization.

e.g: {"authorization":"Bearer {{token}}"}

Sangam CRM API

Sangam CRM API provides both Push and Pull APIs to allow users to interact with the Sangam CRM. To use these APIs, users will need to have access to the Sangam CRM and obtain the necessary API credentials. This API documentation will guide users on how to authenticate and use these APIs.

Push API

The Push API allows users to push data into the Sangam CRM from external sources like websites or any third-party software. This API can be used to add new or update leads, tickets, contacts, or any other data that needs to be stored in the CRM system. Users can create and update data using this API.

API NamePurposeAPI URL
Module ListModule list allows users to retrieve a list of all available modules in the Sangam CRM.{{crm-url}}/api/v1/modulelist
Field ListField List API allows users to retrieve a list of fields for a specific module in the Sangam CRM.{{crm-url}}/api/v1/fieldlist
Insert or Update DataThe insert or update API allows users to add or update records in the CRM while also checking for duplicates on a phone number and email address.{{crm-url}}/api/v1/save-data
Insert or Update Data With Linking ModuleInsert or update data with linking module API allows users to insert or update records in the CRM while also linking between modules.{{crm-url}}/api/v1/save-data

Pull API

The Pull API allows users to retrieve data from the Sangam CRM. This API can be used to get information about leads, tickets, contacts, accounts, opportunities, or any other data that is stored in the CRM. Users can use this API to query the CRM system and retrieve specific data based on their requirements.

API NamePurposeAPI Url
Login APILogin API is used to authenticate users and obtain a valid session ID or access token.{{crm-url}}/api/v1/login
Fetch Data From CRMFetch Data API allows users to retrieve a list of records from a specified module in the CRM based on predefined filters and sorting criteria.{{crm-url}}/api/v1/getentry-list-new

Sangam CRM API Status Codes

Status CodeResponse Message
200Success
400Bad Request
401Unauthorized Access
404CRM URL Not Found
500Server Error
Loading