Pular para o conteúdo principal

ContactSyncResult

results object[]required
  • Array [
  • indexintegerrequired

    Posição da linha em contacts.

    statusstringrequired

    unchanged: a linha não mudou nada. skipped: ninguém foi criado. failed: a linha não foi aplicada — veja reason.

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

    contactIdstring

    O contato criado, atualizado ou já em dia. Ausente em skipped e failed.

    reasonstring

    Em skipped: sem telefone (no_phone), telefone inválido (invalid_phone) ou o plano no teto de contatos (contact_limit_reached). Em failed: a linha não passou na validação (invalid_row, com o detalhe em warnings) ou o mesmo número foi criado ao mesmo tempo por outro caminho (conflict_retry). Nos demais, o que não foi aplicado enquanto o resto foi: o número novo já é de outro contato (phone_conflict), o opt-out foi mantido (kept_opt_out), a supressão impediu o opt-in (kept_suppression) ou os campos do site eram mais antigos que os já aplicados (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[]

    Valores descartados da linha, e por quê.

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

    Quantas linhas terminaram em cada 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
    }
    }