---
title: "CustomEntities.batch_create_or_update"
method: POST
path: "/entities/{custom_entity_api_name}/batch-modify"
tags: ["Custom Entity"]
---

# CustomEntities.batch_create_or_update

`POST /entities/{custom_entity_api_name}/batch-modify`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/{custom_entity_api_name}/batch-modify`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/:custom_entity_api_name/batch-modify/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates or updates CustomEntity records in one request: an item with an id updates that record, an item without one creates a new record.

## Path parameters

- `custom_entity_api_name` string, required

## Query parameters

- `validation-level` integer
- `rollback-method` 0 | 1

## Request body

- BatchCustomEntityInput[]
  - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to this record.
  - `name` string: Name of the entity and its default text representation.
  - `owner_id` string, uuid: Id of the sales user who owns the custom entity record.
  - `share_mode` 0 | 1 | 2 | 3: Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
  - `type_id` string, uuid: Id of the custom entity type.
  - `unit_id` string, uuid: Id of the sales unit.
  - `sharing_units` object[]: Sales units that have been granted shared access to this custom entity record. Editable only when share_mode allows unit sharing.
    - `id` string, uuid: Id of the related CustomEntitySharingSalesUnitRelation record.
  - `sharing_clients` object[]: Users that have been granted shared access to this custom entity record. Editable only when share_mode allows user sharing.
    - `id` string, uuid: Id of the related CustomEntitySharingClientRelation record.
  - `documents` object[]: Documents linked to this custom entity record.
    - `id` string, uuid: Id of the related CloudObjectRelation record.
  - `static_profiles` object[]: Saved view profiles this custom entity record currently matches.
    - `id` string, uuid: Id of the related ProfileRelation record.
  - `tags` object[]: Tag labels applied to this custom entity record.
    - `id` string, uuid: Id of the related TagRelation record.
  - `revision` integer: Revision when entity was lastly changed.
  - `id` string, uuid: ID of object to update.

## Response `200`

Result per item, in request order: the id of the created or updated record, or the error.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` union[]
    - union
      - string, uuid: Id of the created or updated record.
      - Error: The body of every REST error. `code` and `name` are stable identifiers; `message` is for people. The full list of codes is at https://developers.coevera.com/reference/errors/.
        - `http_status` integer, required: HTTP status code.
        - `code` integer: Numeric code of the API error.
        - `name` string: Name of the API error.
        - `message` string: Message describing the error.
        - `success` boolean, required: Always false on error.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)