CRM Field Mappings

Configure how data flows between Kayse AI and your connected CRM system.

List CRM Integrations

GET/v1/crm_integrations

Returns information about connected CRM integrations for your company.

Request

curl -X GET 'https://public-api.kayse.ai/v1/crm_integrations' \
-H 'X-API-KEY: your_api_key'

Response

{
  "integrations": [
    {
      "type": "smartadvocate",
      "enabled": true,
      "connected_at": "2026-01-15T08:00:00Z"
    }
  ]
}

List Field Mappings

GET/v1/crm_mappings/fields

Returns the current field mappings between Kayse and your CRM system.

Request

curl -X GET 'https://public-api.kayse.ai/v1/crm_mappings/fields' \
-H 'X-API-KEY: your_api_key'

Response

{
  "mappings": [
    {
      "kayse_field": "case_status",
      "crm_field": "statusid",
      "direction": "bidirectional"
    },
    {
      "kayse_field": "incident_date",
      "crm_field": "dateofincident",
      "direction": "inbound"
    }
  ]
}

Update Field Mappings

POST/v1/crm_mappings/fields

Creates or updates field mappings between Kayse and your CRM.

Request Body Fields

Field	Required	Type	Description
mappings	true	Array	Array of field mapping objects

mappings[] fields

Field	Required	Type	Description
kayse_field	true	String	Kayse field identifier
crm_field	true	String	CRM field identifier
direction	false	Enum	inbound, outbound, or bidirectional (default: bidirectional)

Request

curl -X POST 'https://public-api.kayse.ai/v1/crm_mappings/fields' \
-H 'X-API-KEY: your_api_key' \
-H 'Content-Type: application/json' \
-d '{
  "mappings": [
    {
      "kayse_field": "case_status",
      "crm_field": "statusid",
      "direction": "bidirectional"
    },
    {
      "kayse_field": "incident_date",
      "crm_field": "dateofincident",
      "direction": "inbound"
    }
  ]
}'

Response

{
  "updated": 2,
  "mappings": [
    {
      "kayse_field": "case_status",
      "crm_field": "statusid",
      "direction": "bidirectional"
    },
    {
      "kayse_field": "incident_date",
      "crm_field": "dateofincident",
      "direction": "inbound"
    }
  ]
}

List Outcome Types

GET/v1/crm_mappings/outcome_types

Returns available outcome types that can be used in CRM mappings and campaign workflows.

Request

curl -X GET 'https://public-api.kayse.ai/v1/crm_mappings/outcome_types' \
-H 'X-API-KEY: your_api_key'

Response

{
  "outcome_types": [
    {
      "id": "qualified",
      "label": "Qualified Lead",
      "description": "Lead meets qualification criteria"
    },
    {
      "id": "not_interested",
      "label": "Not Interested",
      "description": "Lead declined services"
    },
    {
      "id": "callback",
      "label": "Callback Requested",
      "description": "Lead requested callback at later time"
    }
  ]
}