v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Rum Audience Management

Update connection

Update an existing data connection by adding, updating, or deleting fields

put/api/v2/product-analytics/{entity}/mapping/connection

Path parameters

entitystring required
Example:users

The entity for which to update the connection

Request body

Example request

{
  "data": {
    "attributes": {
      "fields_to_add": [
        {
          "description": "Net Promoter Score from customer surveys",
          "display_name": "NPS Score",
          "groups": [
            "Satisfaction",
            "Metrics"
          ],
          "id": "nps_score",
          "source_name": "net_promoter_score",
          "type": "number"
        }
      ],
      "fields_to_delete": [
        "old_revenue_field"
      ],
      "fields_to_update": [
        {
          "field_id": "lifetime_value",
          "updated_display_name": "Customer Lifetime Value (`USD`)",
          "updated_groups": [
            "Financial",
            "Metrics"
          ]
        }
      ]
    },
    "id": "crm-integration",
    "type": "connection_id"
  }
}

Response

Connection updated successfully