Batch upsert Records by external URI

from minikai import Minikai, UpsertRecordDto
client = Minikai(
    token="YOUR_TOKEN_HERE",
)
client.records.upsert_records_by_external_uri(
    items=[
        UpsertRecordDto(
            title="string",
            mini_id="string",
        )
    ],
)

{
  "successfulIds": {},
  "failed": [
    {
      "index": null,
      "item": {
        "title": "string",
        "miniId": "string",
        "id": "string",
        "externalUri": "string",
        "description": "string",
        "eventDate": "2024-01-15T09:30:00Z",
        "relations": [
          {
            "relationship": "duplicate-of",
            "id": "string",
            "targetRecordId": "string",
            "since": "2024-01-15T09:30:00Z"
          }
        ],
        "labels": [
          "string"
        ],
        "tags": {},
        "authorization": {
          "users": [
            "string"
          ],
          "minis": [
            "string"
          ],
          "organizations": [
            "string"
          ],
          "sessions": [
            "string"
          ]
        },
        "state": "active"
      },
      "error": "string"
    }
  ],
  "duplicates": [
    {
      "index": null,
      "item": {
        "title": "string",
        "miniId": "string",
        "id": "string",
        "externalUri": "string",
        "description": "string",
        "eventDate": "2024-01-15T09:30:00Z",
        "relations": [
          {
            "relationship": "duplicate-of",
            "id": "string",
            "targetRecordId": "string",
            "since": "2024-01-15T09:30:00Z"
          }
        ],
        "labels": [
          "string"
        ],
        "tags": {},
        "authorization": {
          "users": [
            "string"
          ],
          "minis": [
            "string"
          ],
          "organizations": [
            "string"
          ],
          "sessions": [
            "string"
          ]
        },
        "state": "active"
      },
      "existingMatches": [
        {
          "recordId": "string",
          "title": "string",
          "eventDate": "2024-01-15T09:30:00Z"
        }
      ],
      "intraBatchDuplicateOf": [
        null
      ]
    }
  ],
  "successCount": null,
  "failureCount": null
}

Deprecated. Create or update Records by external URI. Use POST /Records/batch instead.

Authentication

AuthorizationBearer

Authenticate every request with Authorization: Bearer <api-key>. Manage keys in Workspace Admin > Security & access.

Request

This endpoint expects an object.

itemslist of objectsRequired

allowDuplicatesbooleanOptional

Response

Accepted

successfulIdsmap from strings to stringsOptional

failedlist of objectsOptional

duplicateslist of objectsOptional

successCountanyOptional

failureCountanyOptional

Errors

400

Bad Request Error

422

Unprocessable Entity Error