v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Rum Audience Management

Create connection

Create a new data connection and its fields for an entity

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

Path parameters

entitystring required

Example:users

The entity for which to create the connection

Request body

Example request

{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "description": "Customer lifetime value in `USD`",
          "display_name": "Lifetime Value",
          "id": "lifetime_value",
          "source_name": "ltv",
          "type": "number"
        }
      ],
      "join_attribute": "user_email",
      "join_type": "email",
      "type": "ref_table"
    },
    "id": "crm-integration",
    "type": "connection_id"
  }
}

Response

Connection created successfully