BatchUpsertResult

Result of a batch upsert operation.

results
Type: array object[] · BatchUpsertItemResult[]
required

Results for each item in the batch, in the same order as the request.
Result for a single item in a batch upsert.
- action
  Type: null | string
  
  Action performed: "created", "updated", "revived", or null on error.
- clientRef
  Type: null | string
  
  Client-provided reference from the request (if provided).
- errors
  Type: array object[] | null · BatchUpsertItemError[]
  
  Validation errors (on failure).
  
  Error details for a failed batch item.
- etag
  Type: null | string
  
  ETag of the contact (on success).
- id
  Type: null | string
  
  Contact ID (on success).
- status
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  HTTP status code for this item (200, 201, 400, etc).
summary
Type: object · BatchUpsertSummary
required

Summary statistics for the batch operation.
- created
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  Number of contacts created.
- failed
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  Number of items that failed.
- revived
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  Number of contacts revived from soft-delete.
- total
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  Total number of items in the batch.
- updated
  Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
  
  Number of contacts updated.