Skip to content
Micro micro
Go to Micro
API Reference
Prism
Objects
Deals

Bulk update records (partial success)

POST/v2/prism/{teamId}/deal/batch/update

Patch up to 100 records in a single call. Each item is attempted independently — failures don’t abort the batch. Inspect results[].status per item.

Path ParametersExpand Collapse
teamId: optional string
formatuuid
Header ParametersExpand Collapse
"Idempotency-Key": optional string
minLength1
maxLength255
Body ParametersJSONExpand Collapse
items: array of object { id }
id: string
formatuuid
ReturnsExpand Collapse
results: array of object { id, status, error, record }
id: string

Item ID, or null if the input was unparseable.

status: "ok" or "error"
One of the following:
"ok"
"error"
error: optional object { code, message }
code: optional string
message: optional string
record: optional object { id, default, list }

Object returned by reads (get/create/patch/restore). id is always present.

id: string
formatuuid
default: optional map[unknown]

Properties keyed by property slug.

list: optional unknown
summary: object { failed, succeeded, total }
failed: number
succeeded: number
total: number

Bulk update records (partial success)

curl https://developers.micro.so/v2/prism/$TEAM_ID/deal/batch/update \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $MICRO_API_KEY" \
    -d '{
          "items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            }
          ]
        }'
{
  "results": [
    {
      "id": "id",
      "status": "ok",
      "error": {
        "code": "code",
        "message": "message"
      },
      "record": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "default": {
          "foo": "bar"
        },
        "list": {}
      }
    }
  ],
  "summary": {
    "failed": 0,
    "succeeded": 0,
    "total": 0
  }
}
Returns Examples
{
  "results": [
    {
      "id": "id",
      "status": "ok",
      "error": {
        "code": "code",
        "message": "message"
      },
      "record": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "default": {
          "foo": "bar"
        },
        "list": {}
      }
    }
  ],
  "summary": {
    "failed": 0,
    "succeeded": 0,
    "total": 0
  }
}