---
title: "Batch operations"
method: POST
path: "/crm/batch"
tags: ["crm"]
---

# Batch operations

`POST /crm/batch`

## Request

- Base URL: `https://www.dench.com/api/v1`
- URL: `https://www.dench.com/api/v1/crm/batch`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Apply a CRM batch.

## Request body

- object
  - `withReferences` boolean: Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.
  - `ops` union[], required
    - union: A single CRM batch/transaction operation.
      - object
        - `type` 'entries.create', required
        - `objectName` string, required
        - `data` object, required: Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee.
      - object
        - `type` 'entries.update', required
        - `entryId` string, required
        - `data` object, required: Field-name -> value map. For `user` fields use one member userId or a userId array; preserve every assignee.
      - object
        - `type` 'entries.delete', required
        - `entryId` string, required
  - `idempotencyKey` string

## Response `200`

Successful response

- object
  - `references` union[]
    - union
      - object
        - `kind` 'crm-entry', required
        - `objectName` string, required
        - `entryId` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
      - object
        - `kind` 'crm-object', required
        - `objectName` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
      - object
        - `kind` 'campaign', required
        - `sequenceId` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
  - `referenceCoverage` object
    - `returned` integer, required
    - `available` integer, required
    - `truncated` boolean, required
  - `results` object[], required
    - `entryId` string, required
    - `deleted` boolean
  - `count` number, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid authentication
- `404`: Operation or resource not found
- `500`: Server error

---

[API](https://skmtc.dev/dench/apis/dench-api.md) - [All operations](https://skmtc.dev/dench/apis/dench-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dench/apis/dench-api/revisions/4a145b38f19c?raw)