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

Bulk delete records (partial success)

client.Prism.Objects.Deals.BulkDelete(ctx, params) (*PrismObjectDealBulkDeleteResponse, error)
POST/v2/prism/{teamId}/deal/batch/delete

Soft-delete up to 100 records in a single call. Same partial-success contract as batch/update.

ParametersExpand Collapse
params PrismObjectDealBulkDeleteParams
TeamID param.Field[string]Optional

Path param

formatuuid
IDs param.Field[[]string]

Body param

IdempotencyKey param.Field[string]Optional

Header param: A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. Replays include the idempotent-replay: true response header.

minLength1
maxLength255
ReturnsExpand Collapse
type PrismObjectDealBulkDeleteResponse struct{…}

Partial-success bulk operation result. Inspect results[].status per item; the operation as a whole returns 200 even if some items failed.

Results []PrismObjectDealBulkDeleteResponseResult
ID string

Item ID, or null if the input was unparseable.

Status PrismObjectDealBulkDeleteResponseResultsStatus
One of the following:
const PrismObjectDealBulkDeleteResponseResultsStatusOk PrismObjectDealBulkDeleteResponseResultsStatus = "ok"
const PrismObjectDealBulkDeleteResponseResultsStatusError PrismObjectDealBulkDeleteResponseResultsStatus = "error"
Error PrismObjectDealBulkDeleteResponseResultsErrorOptional
Code stringOptional
Message stringOptional
Record PrismObjectDealBulkDeleteResponseResultsRecordOptional

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

ID string
formatuuid
Default map[string, unknown]Optional

Properties keyed by property slug.

List unknownOptional
Summary PrismObjectDealBulkDeleteResponseSummary
Failed int64
Succeeded int64
Total int64

Bulk delete records (partial success)

package main

import (
  "context"
  "fmt"

  "github.com/micro-so/micro-sdk-go"
  "github.com/micro-so/micro-sdk-go/option"
)

func main() {
  client := micro.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithTeamID("My Team ID"),
  )
  response, err := client.Prism.Objects.Deals.BulkDelete(context.TODO(), micro.PrismObjectDealBulkDeleteParams{
    IDs: micro.F([]string{"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Results)
}

{
  "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
  }
}