Skip to main content

BulkOperationResponseDto

operationIdstringrequired

Unique identifier for the bulk operation

Example: 507f1f77bcf86cd799439011
totalItemsnumberrequired

Total number of items in the operation

Example: 100
successCountnumberrequired

Number of successfully processed items

Example: 95
failureCountnumberrequired

Number of failed items

Example: 5
statusBulkOperationStatusrequired

Current status of the operation

Possible values: [pending, processing, completed, failed]

Example: pending
operationErrors object[]

Array of errors for failed items

  • Array [
  • itemIdstringrequired

    ID of the item that failed

    Example: 507f1f77bcf86cd799439011
    messagestringrequired

    Error message

    Example: Client not found
    codestring

    Error code if available

    Example: 404:MODEL_NOT_FOUND
  • ]
  • results object[]

    Array of results for successful items

  • Array [
  • itemIdstringrequired

    ID of the item

    Example: 507f1f77bcf86cd799439011
    resultobject

    Result data

  • ]
  • createdAtstring<date-time>required

    Timestamp when the operation was created

    Example: 2024-01-01T00:00:00.000Z
    completedAtstring<date-time>

    Timestamp when the operation was completed

    Example: 2024-01-01T00:05:00.000Z
    BulkOperationResponseDto
    {
    "operationId": "507f1f77bcf86cd799439011",
    "totalItems": 100,
    "successCount": 95,
    "failureCount": 5,
    "status": "pending",
    "operationErrors": [
    {
    "itemId": "507f1f77bcf86cd799439011",
    "message": "Client not found",
    "code": "404:MODEL_NOT_FOUND"
    }
    ],
    "results": [
    {
    "itemId": "507f1f77bcf86cd799439011",
    "result": {}
    }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "completedAt": "2024-01-01T00:05:00.000Z"
    }

    API news, once a month

    New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

    Report a technical problem

    An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

    For a fast answer, include:

    • The method and endpoint (e.g. POST /clients)
    • The error code returned (errorCode) and the body sent
    • The date and time of the call
    • The identifiers involved (customer, template, pass)

    Never include an API token or a password.

    AI assistant

    Beta

    Loading…

    AI-generated answers (Claude): double-check important details.

    Sign in to use the assistant