Skip to main content

ContactSyncResult

results object[]required
  • Array [
  • indexintegerrequired

    The row's position in contacts.

    statusstringrequired

    unchanged: the row changed nothing. skipped: nobody was created. failed: the row was not applied — see reason.

    Possible values: [created, updated, unchanged, skipped, failed]

    contactIdstring

    The contact created, updated or already up to date. Absent on skipped and failed.

    reasonstring

    On skipped: no phone (no_phone), an invalid phone (invalid_phone) or the plan at its contact cap (contact_limit_reached). On failed: the row did not pass validation (invalid_row, with the detail in warnings) or the same number was created at the same instant by another path (conflict_retry). On the others, what was not applied while the rest was: the new number already belongs to another contact (phone_conflict), the opt-out was kept (kept_opt_out), a suppression blocked the opt-in (kept_suppression) or the site's fields were older than the ones already applied (stale_snapshot).

    Possible values: [no_phone, invalid_phone, contact_limit_reached, invalid_row, conflict_retry, phone_conflict, kept_opt_out, kept_suppression, stale_snapshot]

    warnings object[]

    Values dropped from the row, and why.

  • Array [
  • fieldstring
    Example: attributes.wc_orders_count
    reasonstring
  • ]
  • ]
  • summary objectrequired

    How many rows ended in each status.

    createdintegerrequired
    updatedintegerrequired
    unchangedintegerrequired
    skippedintegerrequired
    failedintegerrequired
    ContactSyncResult
    {
    "results": [
    {
    "index": 0,
    "status": "created",
    "contactId": "string",
    "reason": "no_phone",
    "warnings": [
    {
    "field": "attributes.wc_orders_count",
    "reason": "string"
    }
    ]
    }
    ],
    "summary": {
    "created": 0,
    "updated": 0,
    "unchanged": 0,
    "skipped": 0,
    "failed": 0
    }
    }