TWtwilio
TwilioInsightsConfig

Fetch a custom field mapping

Changed on

Returns a single custom field mapping by its mappingId. The ETag response header identifies the mapping's current version; supply it as If-Match on PATCH to guard against concurrent updates.

get/v3/ControlPlane/ConversationInsights/CustomFieldMappings/{mappingId}

Request

  • Base URL
    https://insights.twilio.com
  • URL
    https://insights.twilio.com/v3/ControlPlane/ConversationInsights/CustomFieldMappings/{mappingId}
  • Auth
    HTTP basic

Path parameters

mappingIdstring required
Example:convinsights_mapping_01m31967b7em08vh1pqgbam3mj

The unique identifier of the custom field mapping, as returned in id when the mapping was created.

Response

The custom field mapping.

idstring

The unique identifier of the custom field mapping.

category'MEASURE' required

The category of the custom field. Supported values:

  • MEASURE: a numeric value that can be aggregated and queried as a measure in Conversations Insights.
namestring required

Name of the custom field, unique within the account.

descriptionstring

Optional, free-text description supplied at registration time. Display-only — not part of any uniqueness check.

createdAtstring date-time

When the mapping was registered.

updatedAtstring date-time nullable

When the mapping was last modified via PATCH. Null until the first update.

Example response

{
  "id": "convinsights_mapping_01m31967b7em08vh1pqgbam3mj",
  "name": "LeadScore",
  "description": "Lead quality score derived from sentiment analysis",
  "entityMetadata": {
    "intelligenceOperator": {
      "operatorId": "intelligence_operator_01kcgy1ew0e9x8re6jq542zt8b",
      "operatorName": "Sentiment Analysis",
      "field": "leadScore"
    }
  },
  "createdAt": "2026-08-13T14:30:00Z",
  "updatedAt": "2026-09-30T10:00:00Z"
}

Changes