Reanalisa a planilha e, com o mapeamento, devolve o resumo
POST/api/members/imports/{id}/preview
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Owner e admin; só enquanto a importação está `ANALYZED`. Com `sheet`, `headerRow` (1 a 30), `delimiter` (`,` `;` tab `|`) ou `encoding` (`utf-8`, `windows-1252`, `iso-8859-1`, `utf-16le`, `utf-16be`), devolve a análise de novo. Com `mapping` (e `options`), devolve também `summary`, o resumo do passo 4: linhas, pessoas novas, já membros (recebem grupos, tags e campos vazios), ignoradas por motivo (`NO_EMAIL`, `INVALID_EMAIL`, `DUPLICATE_IN_FILE`, `NO_CONSENT`), `declined` (pediram para não participar, fora de `skipped`), e-mails a enviar e os grupos, tags e campos que serão criados. Não grava nada. O mapeamento exige exatamente uma coluna `email`; `firstName`, `lastName`, `phone` e `consent` aceitam uma coluna cada (duas colunas para o mesmo destino são recusadas); `tags` e `groups` aceitam várias.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
sheetoptional | string | |
headerRowoptional | integer | ≥ 1, ≤ 30 |
delimiteroptional | , | ; | | | | |
encodingoptional | string | |
mappingoptional | object[] | |
mapping[].columnrequired | integer | O `index` da coluna, como veio na análise. |
mapping[].targetrequired | ignore | email | firstName | lastName | phone | tags | groups | consent | field | newField | |
mapping[].fieldKeyoptional | string | Com `field`: a `key` de um campo customizado existente. |
mapping[].newFieldoptional | object | Com `newField`: o campo criado na hora, sempre opcional. |
mapping[].newField.labeloptional | string | max 120 |
mapping[].newField.typeoptional | TEXT | NUMBER | DATE | SELECT | BOOLEAN | |
optionsoptional | object | |
options.roleoptional | member | moderator | |
options.groupIdsoptional | string (uuid)[] | |
options.tagsoptional | string[] | |
options.originoptional | string | De onde veio a lista. Obrigatória no start; texto simples, sem link; vai no e-mail. · max 150 |
options.consentValuesoptional | string[] | Com uma coluna `consent`: os valores que contam como sim. |
options.consentDeclarationoptional | boolean | Sem coluna `consent`: a declaração aceita (obrigatória no start). |
Responses
| Status | Description |
|---|---|
200 | A análise, com `summary` quando veio o mapeamento. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | A importação já foi confirmada ou abandonada. |
429 | Outra planilha está sendo lida nesta comunidade (uma por vez) ou no servidor. Tente de novo em instantes (`reason: busy`). |
curl example
curl -X POST "https://api.memberfy.net/api/members/imports/<id>/preview" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'