---
title: "Upsert GTM entity records"
method: POST
path: "/platform/v1/entities/{entityName}"
tags: ["entities"]
---

# Upsert GTM entity records

`POST /platform/v1/entities/{entityName}`

## Request

- Base URL: `https://api.zoominfo.com/gtm`
- URL: `https://api.zoominfo.com/gtm/platform/v1/entities/{entityName}`
- Auth: OAuth 2
  - Authorization code: `https://login.zoominfo.com`
  - Token URL: `https://okta-login.zoominfo.com/oauth2/default/v1/token` scopes: `api:gtm-data-model:manage`

Create or update entity records in the GTM data model

## Path parameters

- `entityName` 'account' | 'contact' | 'user', required

## Request body

- UpsertDataPayload: Represents an entity that contains records collection.
  - `data` UpsertRecord[], required: The primary data of the document
    - `id` string: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` GtmModelAttributes, required: Attributes for GTM model records.

## Response `200`

Success

- UpsertResponse: Response model containing the results of GTM model record upsert operations.
  - `data` GtmResponseModel, required: GtmResponseModel
    - `id` string, required: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` UpsertResultModel, required: UpsertResultModel
      - `recordsProcessed` number, required: recordsProcessed
      - `recordsSuccessful` number, required: recordsSuccessful
      - `recordsFailed` number, required: recordsFailed
      - `processedRecords` UpsertRecord[], required: processedRecords
        - `id` string: The unique identifier for the resource
        - `type` string, required: The type of the resource
        - `attributes` GtmModelAttributes, required: Attributes for GTM model records.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/zoominfo/apis/platform-api-v1.md) - [All operations](https://skmtc.dev/zoominfo/apis/platform-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/zoominfo/apis/platform-api-v1/revisions/3f7645433626?raw)